Configurar plano de tabela de preços

Esta é a documentação do Apigee Edge.
Acesse 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, É necessário fornecer detalhes adicionais, como o modelo de cobrança e o preço para o modelo de cobrança.

Como opção, é possível especificar um plano freemium para produtos individuais (em vez de para uma API) pacote), você pode fazer 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, bem como pacotes de API (planos por volume e por pacote), Ambos os casos envolvem momentos específicos em que as taxas são cobradas e os planos de pacote são redefinidos como zero. A A tabela a seguir descreve quando as taxas recorrentes são cobradas e as contagens de pacotes são redefinidas. Se os apps de desenvolvedores são impedidos de fazer outras chamadas de API porque alcançaram um determinado o 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 pode voltar a fazer chamadas.

Se o plano tiver... ...isso acontece
  • Uma taxa recorrente diferente de zero definida como Month
  • Um plano de pacote ou com faixas de volume

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

Para uma recorrência mensal em um dia específico, crie um plano de tarifas usando o modelo API e indicar o dia com uma propriedade RecurringStartUnit, conforme descrito em Como criar planos de tarifas usando a API.
  • Uma taxa recorrente diferente de zero definida como Semana.
  • Um plano de pacote ou com faixas de volume
 A taxa recorrente e a redefinição do plano de pacote ocorrem a cada sete dias após a tarifa do desenvolvedor a data de início do plano.
  • Uma taxa recorrente diferente de zero definida como Dia
  • Um plano de pacote ou com faixas de volume
 A taxa recorrente e a redefinição do plano de pacote ocorrem a cada X dias após a a data de início do plano de preços do desenvolvedor.
  • Não há taxa recorrente (ou zero dólar)
  • Um plano de pacote ou com faixas de volume

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

O dia do mês nem sempre é o mesmo. Por exemplo, se uma taxa plano começa em 31 de dezembro, a data de redefinição passa a ser o dia 28 de um ano não bissexto fevereiro, já que fevereiro tem apenas 28 dias. O dia 28 continua sendo o dia redefinido de todos os tempos.

Configurar planos de tabelas de preços usando o interface

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

Edge

Para configurar um plano de tabela de preços, crie ou edite um plano de tarifas, selecione o tipo de plano de tarifas 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 O desenvolvedor é cobrado por uma taxa fixa para cada transação.
Volume em banda O desenvolvedor paga uma taxa variável de acordo com o volume de transações.
Pacotes O desenvolvedor recebe uma cobrança antecipada de um valor definido para cada pacote de transações. O valor definido é cobrado do desenvolvedor, independentemente de o pacote ser usado totalmente ou não.

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

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

Modelo de carregamento Campo Descrição
Todos Frequência do cálculo Período em que o volume de transações (ou 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: você pode 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 taxas de planos de tarifas.

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

Volume em banda Bandas de volume Um ou mais intervalos de volume de transações (ou com base nos atributos do cliente). Cada intervalo é uma "banda de volume" para o modelo de cobrança por volume. É possível atribuir uma taxa 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 inferior é predefinido para maior que 0).

Clique em +Novo para adicionar outras faixas.

Deixe o limite superior da faixa final em branco para indicar todas as transações acima desse nível.

Observação: você pode 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 taxas de planos de tarifas.

Por exemplo, se você especificar duas faixas de volume na seção "Banda de volume" (>0 a 1.000 e acima de 1.000), insira 0,15 para a faixa de volume >0 a 1.000 e 0, 10 para a banda 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 mais de 1.000 transações, a taxa será de US $0,10 para cada transação.

Pacotes Preços dos pacotes de APIs Número de transações em um pacote (ou um número relacionado a um atributo personalizado, como um 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, por exemplo, até 1.000 (o limite mínimo é predefinido para 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: você pode 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 taxas de planos de tarifas.

Por exemplo, se você especificar dois pacotes na seção "Tamanho do pacote" (maior que 0 a 1.000 e maior que 1.000 até 2.000), poderá 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á US $50, e o da segunda, US $40. O preço do pacote aplicável é cobrado do desenvolvedor independentemente de quantas transações são usadas nele, ou seja, o desenvolvedor recebe a cobrança do preço do pacote assim que a primeira transação é concluída.

Se você definiu atributos personalizados para seu produto de API, pode configurar um parâmetro de avaliação personalizada para cobrar o desenvolvedor do app com base em um atributo personalizado dentro de cada transação. Por exemplo, se você configurar um plano em que cobra o desenvolvedor por cada transação, poderá 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 por 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ção com atributos personalizados.

Edge clássico (nuvem privada)

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

  1. Siga as etapas para criar um plano de tarifas.
  2. Selecione Tabela de preços no menu suspenso Tipo de plano de preços 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 do produto para configurar os detalhes do plano de tarifas de cada produto de API individualmente.
    • Plano genérico para todos os produtos para configurar detalhes do plano de tarifas de todos os produtos de API.
  4. Clique em Tabela de preços para o plano de tarifas genérico ou para cada plano de tarifas específico do produto da API.

    Observação: ao configurar planos específicos para 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 uso sem custo financeiro de uma produto de API por um período ou com base na quantidade de uso.

    Digite as seguintes informações:

    Campo Descrição
    Produto freemium?

    A duraçã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 na quantidade especificada no volume .
    • Por duração. O período da taxa é baseado em um intervalo de tempo especificado no campo Freemium Duration.
    • O que vier primeiro. O período sem custo financeiro terminará quando a quantidade no volume ou o intervalo de tempo do campo Duração do Freemium for 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 volume pertencente a um atributo personalizado registrado no a política de gravação de transações) que não são cobrados dos desenvolvedores. O volume é medida para o produto da API. Insira um número de volume, como 5000. Isso significa que quando os desenvolvedores iniciarem o plano, eles não serão cobrados pelas primeiras 5.000 transações ou nos primeiros 5.000 usos de um item relacionado a um atributo personalizado. Este campo é ativado apenas se você selecionar "Por quantidade" ou "O que vier primeiro" no menu "Freemium" Produto?" .
    Duração do Freemium

    É o intervalo de tempo em que os desenvolvedores não são cobrados. Digite um número e selecione um período, por exemplo, 1 mês. Isso significa que os desenvolvedores não estão cobrado por um mês. Esse campo só será ativado se você selecionar "Por duração" ou "O que vier primeiro" na seção "Produto freemium"? .
  6. Selecione um dos seguintes modelos de carregamento:
    • Taxa fixa. Nesse modelo, o desenvolvedor é cobrado por uma taxa fixa transação.
    • Volume em banda. Nesse modelo, o desenvolvedor é cobrado por uma taxa variável, dependendo volume de transações.
    • Pacotes. Nesse modelo, o desenvolvedor é cobrado por um valor definido (adiantado) por um pacote de transações. O valor definido é cobrado do desenvolvedor, independentemente de o pacote é totalmente usado.

    Para o modelo de taxa fixa:insira as seguintes informações na seção "Preços" do na janela da tabela de preços genérica:

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

    O nome da organização. Esse campo é predefinido com o uso das teclas "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 detalhes, consulte Configurar o número de casas decimais para as taxas de planos de tarifas.

    Por exemplo, se você inserir 0, 10 e a moeda for dólares americanos, o desenvolvedor cobrado US $0,10 para cada transação (ou se com base em um atributo personalizado, como o número de bytes transmitidos em uma transação, o desenvolvedor recebe uma cobrança de US $0,10 transmitindo o número especificado de bytes).

    Para o modelo com faixas de volume:a janela "Tabela de preços genérica" exibe informações que você usa para especificar uma base para agregação e "faixas de volume", que são os intervalos de volume de transações em que é possível aplicar taxas diferentes.

    Esse tipo de plano geralmente é configurado para incentivar os desenvolvedores a gerar volumes maiores e oferecer taxas com desconto para faixas 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 de tempo em que o volume de transações (ou volume relacionado a atributos) é agregado. O volume agregado é usado para identificar a faixa de volume e a taxa que serão aplicadas a cada transação. Selecione um número de meses (1 a 12 meses).

    Confira mais detalhes sobre quando os pacotes são redefinidos em Quando são recorrentes as taxas cobradas e o plano de pacote foi redefinido?
    Faixas de volume

    Um ou mais intervalos de volume de transações (ou com base no atributo do cliente) (cada faixa) é uma "banda de volume"). É possível atribuir uma taxa a cada faixa de volume (você define essa taxa no campo Faixas de volume da seção Preço). A taxa é aplicada a todos os transações na faixa de volume aplicável. Especifique o limite máximo do primeiro banda, por exemplo, até 1.000 (o limite mínimo é predefinido para maior que 0). Clique em + para adicionar uma segunda banda, por exemplo, de 1.000 a 2.000. Clique em "+" para adicionar mais bandas Você pode deixar o limite superior da faixa final em branco para indicar todos transações acima desse nível.
    Preços
    Operador (ou organização)

    O nome da organização. Esse campo é predefinido com o uso das teclas "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 organização usa. Este campo é predefinida usando o valor do campo "Moeda" no perfil da organização, mas pode ser alterado aqui.
    Bandas de volume

    A taxa de uma banda 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 detalhes, consulte Configurar o número de casas decimais para as taxas de planos de tarifas.

    Por exemplo, se você especificar duas faixas de volume na seção "Banda de volume" (>0-1000 e 1000 e acima), você pode inserir 0,15 para o volume >0-1000 banda de 1000 e acima de 0, 10. Se a moeda selecionada for os EUA a taxa para as primeiras 1.000 transações é 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 uma delas.

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

    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 use um pacote personalizado com base em atributos). Selecione um número de meses (1 a 12). Depois período, o plano expira, e o desenvolvedor precisa adquirir o plano (e os pacotes) de novo.

    Confira mais detalhes sobre quando os pacotes são redefinidos em Quando são recorrentes as taxas cobradas e o plano de pacote foi redefinido?
    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 ser atribuído Um preço (você define esse preço no campo Tamanho do pacote da seção Preço). A o preço se aplica a todo o pacote. Especifique o limite máximo do primeiro pacote, por exemplo, até 1.000 (o limite mínimo é predefinido para maior que 0). Clique em "+" para adicionar um segundo pacote, por exemplo, de 1.000 a 2.000. Clique em "+" para adicionar mais pacotes. Você deve especificar um limite máximo para o último pacote, a menos que queira cobrar do desenvolvedor um valor fixo por transações ilimitadas nos últimos feixe.
    Preços
    Operador (ou organização)

    O nome da organização. Esse campo é predefinido com o uso das teclas "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 organização usa. Este campo é predefinida usando o valor do campo "Moeda" no perfil da organização, mas pode ser alterado aqui.
    Tamanho do pacote (preço)

    O preço de um pacote. Você especifica um preço para cada pacote. Insira um número decimal número (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 detalhes, consulte Configurar o número de casas decimais para as taxas de planos de tarifas.

    Por exemplo, se você especificar dois pacotes na seção "Tamanho do pacote" (maior que 0) até 1.000 e de 1.000 a 2.000), insira 50 para o maior de 0 a 1.000 pacotes e de 40 para pacotes maiores que 1.000 até 2.000. Se o a moeda selecionada é o dólar americano, o preço do primeiro pacote é US $50, e a segundo pacote, o preço será de US $40. O preço do pacote aplicável é cobrado do desenvolvedor. independentemente de quantas transações forem usadas no pacote (ou seja, o O desenvolvedor recebe a cobrança do preço do pacote assim que a primeira transação no pacote é concluída for concluída.
  7. Clique em Aplicar e fechar para salvar os detalhes da tabela de preços e retornar ao plano de tarifas padrão. janela.
  8. Para planos de preços específicos de produtos de API, configure os detalhes do plano para outros produtos de API, conforme necessário.

Como configurar o plano da tabela de preços usando a API

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

Como especificar detalhes do plano da tabela de preços usando a API

Você especifica os detalhes do plano da tabela de preços ao criá-lo. Você especifica os detalhes a propriedade ratePlanDetails no corpo da solicitação em uma chamada para /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. O que você especificar na propriedade ratePlanDetails, depende do modelo de carregamento escolhido: taxa fixa, volume com faixas ou pacotes.

Especificar um modelo de cobrança de taxa fixa

Para implementar o modelo de cobrança de taxa fixa, especifique o seguinte no plano de tarifas detalhes:

  • Um parâmetro de classificação que indica que o plano de tarifas é baseado em transações. (VOLUME) ou com base 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 não se baseia no volume de transações, como é o caso do volume modelo de carregamento por 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 taxa de plano de tarifação que fornece detalhes sobre como a taxa é calculada. Como o modelo de cobrança for baseado em uma taxa fixa, você especificará somente uma taxa do plano de tarifas.

Na taxa do plano de tarifa, você especifica:

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

Consulte Plano de tarifas as definições de configuração dos detalhes para uma lista completa das opções detalhadas do plano de tarifas.

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

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

Especificação um modelo de carregamento em banda de volume

Em um modelo com faixas de volume, você especifica os detalhes do plano de tarifação que incluem um ou mais planos de tarifas. do Google, cada uma delas se aplica a uma "banda de volume", ou seja, um intervalo de volume de transações com base em um atributo personalizado, como o número de bytes transmitidos). Esse tipo de plano é geralmente são configurados para incentivar os desenvolvedores a gerar volumes maiores, oferecendo descontos para bandas de volume mais altas.

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

  • Um parâmetro de classificação que indica que o plano de tarifas é baseado em transações. (VOLUME) ou com base 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 (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.
  • Um tipo de duração e que, juntos, especificam o período em que o volume de transações (ou volume relacionado a atributos personalizados) são agregados. Isso também é chamado de "base de agregação". O volume de transações é agregado com base na 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 tarifa de plano de tarifa, você especifica:

  • O tipo de taxa do plano de tarifação (RATECARD).
  • A taxa do plano. Por exemplo, se você especificar 0, 10 e a moeda for dólares americanos, o desenvolvedor é cobrado US $0,15 por cada transação (ou se for baseado em um atributo personalizado, como número de bytes transmitidos em uma transação, serão cobrados US $0,15 do desenvolvedor transmitindo o número especificado de bytes).
  • A unidade inicial e final da banda de volume. A unidade inicial especifica a menor da banda de volume, e a unidade final especifica o limite superior da banda de volume. Para exemplo, se você especificar uma unidade inicial de 0 e uma unidade final de 1.000, a banda de volume abrangerá de até 1.000 transações no período de agregação. Se a moeda for o dólar americano, período de agregação é de 1 mês e a taxa das primeiras 1.000 transações é 0, 15, a desenvolvedor recebe uma cobrança de 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 planos de pacote foram redefinidos?

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

Consulte Plano de tarifas as definições de configuração dos detalhes para uma lista completa das opções detalhadas do plano de tarifas.

Por exemplo, o código a seguir cria um plano de tabela de preços com um modelo de cobrança por volume. A é 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 vence 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

Especificar um modelo de carregamento em pacote

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

Por exemplo, suponha que você configurou dois pacotes, em que o tamanho do primeiro é de 1 a 1.000 transações, e um segundo tamanho de pacote é de 1.001 a 2.000 transações. A taxa é de US $50 para para o primeiro pacote e US $40 para o segundo, e a base da agregação é 1. Se o desenvolvedor compra um plano de tabela de preços para o primeiro pacote, ele paga US $50 (adiantado) por 1.000 transações por mês. O valor definido é cobrado do desenvolvedor, independentemente de o pacote ter sido totalmente usado ou não. Após o término do período de agregação, o plano expira. Se o desenvolvedor quiser usar o pacote ele precisará comprar o plano (e o pacote) outra vez.

O que você especifica nos detalhes do plano de tarifação é basicamente o mesmo que você especifica no Detalhes do plano de tarifas para o modelo de carregamento em faixas de volume. As diferenças são as seguintes:

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

Consulte Plano de tarifas as definições de configuração dos detalhes para uma lista completa das opções detalhadas do plano de tarifas.

Por exemplo, as informações a seguir criam um plano de tabela de preços com um modelo de cobrança em pacote. A taxa é de US $50 para o primeiro pacote (até 1.000 transações) e US $40 para o segundo (mais de 1.000 a 2.000 transações). A base da 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 tabela de preços, é possível configurar um plano freemium para um produto individual (em vez de um pacote de API). Um plano freemium oferece aos desenvolvedores uso sem custo financeiro de um produto de API por um período de por tempo de uso ou com base na quantidade de uso.

Ao configurar um plano freemium para um produto de API, você especifica nos detalhes do plano da tabela de preços o período em que o desenvolvedor pode usar os recursos fornecidos pelo produto de API sem carga. 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 envolvendo o produto da API ou o volume sobre 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. Para o exemplo a seguir cria um plano de tabela de preços com um plano freemium baseado em um volume de 5.000 (as especificações relacionadas ao 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