Você está lendo a documentação do Apigee Edge.
Acesse a documentação da
Apigee X. info
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 dele.
Se quiser, especifique um plano freemium para produtos individuais (em vez de um pacote de API). Isso só pode ser feito 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 taxas podem incluir taxas recorrentes e pacotes de API (planos de faixa de volume e pacote), que envolvem horários específicos em que as taxas são cobradas e os planos de pacote são redefinidos para zero. 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 forem bloqueados de fazer mais chamadas de API porque atingiram um determinado limite de transações, estes serão os momentos em que as contagens de chamadas de API serão redefinidas para zero e os apps poderão começar a fazer chamadas novamente.
| Se o plano tiver... | ...isso acontece |
|---|---|
|
A taxa recorrente e a redefinição do plano do pacote ocorrem 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
Management e indique o dia com uma propriedade |
|
A taxa recorrente e a redefinição do plano de pacote ocorrem a cada sete dias após a data de início do plano de preços do desenvolvedor. |
|
A taxa recorrente e a redefinição do plano de pacote ocorrem a cada X dias após a data de início do plano de preços do desenvolvedor. |
|
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 iniciar um plano de tarifas no dia 19 do mês e a base de agregação for a cada um mês, o uso do pacote será redefinido todo mês no dia 19. O dia do mês nem sempre é o mesmo. Por exemplo, se um plano de tarifas começar em 31 de dezembro, a data de redefinição será 28 de fevereiro em um ano não bissexto, já que fevereiro tem apenas 28 dias. O dia 28 continua sendo o dia de redefinição. |
Como configurar planos de tabela de preços usando a interface
Configure os planos da tabela de preços, conforme descrito abaixo.
Edge
Para configurar um plano de tabela de preços, ao criar ou editar um plano de tarifas, selecione o tipo Tabela de preços ou Tabela de preços e participação na receita e, na seção Tabela de preços, escolha um dos seguintes modelos de cobrança:
| Modelo de cobrança | Descrição |
| Preço fixo | O desenvolvedor paga uma taxa fixa por cada transação. |
| Volume agrupado | O desenvolvedor paga uma taxa variável dependendo do volume de transações. |
| Pacotes | O desenvolvedor paga um valor fixo antecipado por cada pacote de transações. O desenvolvedor recebe a cobrança do valor definido, mesmo que o pacote não seja usado por completo.
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 seguintes informações com base no modelo de cobrança selecionado.
| Modelo de cobrança | Campo | Descrição |
| Todos | 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). |
| Preço fixo | Taxa fixa | Taxa cobrada por 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 taxas do plano de tarifas. Por exemplo, se você inserir 0,10 e a moeda for o dólar americano, o desenvolvedor vai receber uma cobrança de US $0,10 por transação. Se a cobrança for baseada 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 por transmitir o número especificado de bytes. |
| Volume agrupado | Bandas de volume | Um ou mais intervalos de volume de transação (ou com base em atributos do cliente), em que cada intervalo é uma "faixa de volume" para o modelo de cobrança por faixa de volume. Cada faixa de volume pode receber uma taxa. A taxa é aplicada a todas as transações na faixa de volume aplicável. Especifique o limite superior da primeira faixa, por exemplo, até 1.000 (o limite inferior é predefinido como maior que 0).
Clique em +Novo para adicionar mais intervalos. Deixe o limite superior da faixa final 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 mais detalhes, consulte Configurar o número de casas decimais para as taxas do plano de tarifas. Por exemplo, se você especificar dois intervalos de volume na seção "Intervalo de volume" (>0-1000 e 1000 ou mais), poderá inserir 0,15 para o intervalo >0-1000 e 0, 10 para o intervalo 1000 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 por transação. Para mais de 1.000 transações, a taxa será de US $0,10 por transação. |
| Pacotes | Preços dos pacotes de API | 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. O preço se aplica a todo o pacote. Especifique o limite superior do primeiro pacote, por exemplo, até 1.000 (o limite inferior é predefinido como maior que 0).
Clique em +Novo para adicionar mais pacotes. Você precisa especificar um limite máximo para o último pacote, a menos que 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 mais detalhes, consulte Configurar o número de casas decimais para as taxas do plano de tarifas. Por exemplo, se você especificar dois pacotes na seção "Tamanho do pacote" (maior que 0 até 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á de US $50, e o do segundo, US $40. O desenvolvedor recebe a cobrança do preço do pacote aplicável, independente de quantas transações ele usa dentro do pacote. Ou seja, o preço do pacote é cobrado assim que a primeira transação é concluída. |
Se você definiu atributos personalizados para seu produto de API, é possível configurar um parâmetro de classificação personalizada para cobrar do desenvolvedor de apps com base em um atributo personalizado em cada transação. Por exemplo, se você configurar um plano em que cobra o desenvolvedor por cada transação, poderá definir a taxa 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 classificação personalizada e escolha o atributo personalizado na lista suspensa. Para mais informações, consulte Configurar um plano de tarifas com atributos personalizados.
Classic Edge (nuvem privada)
Para configurar planos de tabela de preços usando a interface clássica do Edge:
- Siga as etapas para criar um plano de preços.
- Selecione Tabela de preços no menu suspenso "Tipo de plano de tarifas" para configurar o modelo de receita.
- Se o pacote de API selecionado incluir vários produtos de API, escolha uma das seguintes opções:
Observação: se o pacote de API incluir um único produto de API, ignore esta etapa.
- Planos específicos do produto para configurar detalhes do plano de taxas de cada produto de API individualmente.
- Plano genérico para todos os produtos para configurar detalhes do plano de tarifas para todos os produtos de API.
- Clique em Tabela de preços para o plano de taxas genérico ou para cada plano de taxas específico do produto de API.
Observação: ao configurar planos específicos de produtos de API, é necessário configurar um plano de tabela de preços para cada produto de API individualmente.
A janela "Tabela de preços" será aberta.
- 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 por 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 custos financeiros. 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 do freemium".
- O que acontecer 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 volume referente a um atributo personalizado registrado na política de registro de transações) pelo qual os desenvolvedores não são cobrados. O volume é medido para o produto de API. Insira um número de volume, como 5.000. Isso significa que, quando os desenvolvedores iniciam o plano, não há cobrança pelas primeiras 5.000 transações (ou pelos primeiros 5.000 usos de um item relacionado a um atributo personalizado). Esse campo só será ativado se você selecionar "Por quantidade" ou "O que vier primeiro" no campo "Produto freemium?".
Duração do freemium O intervalo de tempo em que os desenvolvedores não são cobrados. Insira um número e selecione um período, por exemplo, "1 mês". Isso significa que os desenvolvedores não vão receber cobranças por um mês. Esse campo só será ativado se você selecionar "Por duração" ou "O que vier primeiro" no campo "Produto freemium?".
- Selecione um dos seguintes modelos de cobrança:
- Taxa fixa. Nesse modelo, o desenvolvedor paga uma taxa fixa por cada transação.
- Volume agrupado. Nesse modelo, o desenvolvedor paga uma taxa variável dependendo do volume de transações.
- Pacotes. Nesse modelo, o desenvolvedor paga um valor definido (antecipado) por cada pacote de transações. O desenvolvedor recebe o valor definido, mesmo que o pacote não seja usado por completo.
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 organização. Esse campo é predefinido usando o valor do campo "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.
Preço fixo A taxa cobrada por 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 taxas do plano de tarifas.
Por exemplo, se você inserir 0,10 e a moeda for o dólar americano, o desenvolvedor vai receber uma cobrança de US $0,10 por transação. Se a cobrança for baseada 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 por transmitir o número especificado de bytes.
Para o modelo de faixas de volume:a janela "Tabela de preços genérica" mostra outros campos que você usa para especificar uma base de agregação e faixas de volume, ou seja, intervalos de volume de transações para os quais é possível aplicar taxas diferentes.
Esse tipo de plano geralmente é configurado para incentivar os desenvolvedores a gerar volumes maiores, oferecendo taxas com desconto para faixas de volume mais altas.
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 o volume relacionado a um atributo personalizado) é agregado. O volume agregado é usado para identificar a faixa de volume e a taxa a ser aplicada a cada transação. Selecione um número de meses (de 1 a 12).
Para saber quando os pacotes são redefinidos, consulte Quando as taxas recorrentes são cobradas e os planos de pacote são redefinidos?
Intervalos de volume Um ou mais intervalos de volume de transação (ou com base em atributos do cliente). Cada intervalo é uma "faixa de volume". Cada faixa de volume pode receber uma taxa, que é definida no campo "Faixas de volume" da seção "Preços". A taxa é aplicada a todas as transações na faixa de volume aplicável. Especifique o limite superior da primeira faixa, por exemplo, até 1.000 (o limite inferior é predefinido como maior que 0). Clique em + para adicionar um segundo intervalo, por exemplo, maior que 1.000 até 2.000. Clique em + para adicionar mais intervalos. Você pode deixar o limite superior da faixa final em branco para indicar todas as transações acima desse nível.
Preços Operador (ou organização) O nome da organização. Esse campo é predefinido usando o valor do campo "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 usada pela sua organização. Esse campo é predefinido usando o valor do campo "Moeda" no perfil da organização, mas pode ser alterado aqui.
Bandas 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 da faixa de volume usando a API, não a interface. Para mais detalhes, consulte Configurar o número de casas decimais para as taxas do plano de tarifas.
Por exemplo, se você especificar dois intervalos de volume na seção "Intervalo de volume" (>0-1000 e 1000 ou mais), poderá inserir 0,15 para o intervalo >0-1000 e 0, 10 para o intervalo 1000 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 por transação. Para mais de 1.000 transações, a taxa será de US $0,10 por transação.
Para o modelo agrupado:a janela "Tabela de preços genérica" mostra campos adicionais que você usa para especificar uma base de agregação (o período em que o desenvolvedor pode usar o pacote de transações) e informações relacionadas ao pacote, como o tamanho de um pacote.
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 um pacote personalizado com base em atributos). Selecione um número de meses (de 1 a 12). Após esse período, o plano expira, e o desenvolvedor precisa comprar o plano (e os pacotes) novamente.
Para saber 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, que é definido no campo "Tamanho do pacote" da seção "Preços". O preço se aplica a todo o pacote. Especifique o limite superior do primeiro pacote, por exemplo, até 1.000 (o limite inferior é predefinido como maior que 0). Clique em + para adicionar um segundo agrupamento, por exemplo, maior que 1.000 até 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 organização. Esse campo é predefinido usando o valor do campo "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 usada pela sua organização. Esse campo é predefinido 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 (com até quatro casas decimais).
Observação: é possível configurar o número de casas decimais que podem ser especificadas para a taxa do pacote usando a API (não a interface). Para mais detalhes, consulte Configurar o número de casas decimais para as taxas do plano de tarifas.
Por exemplo, se você especificar dois pacotes na seção "Tamanho do pacote" (maior que 0 até 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á de US $50, e o do segundo, US $40. O desenvolvedor recebe a cobrança do preço do pacote aplicável independente de quantas transações ele usa dentro do pacote. Ou seja, o desenvolvedor recebe a cobrança do preço do pacote assim que a primeira transação do pacote é concluída.
- Clique em Aplicar e fechar para salvar os detalhes da tabela de preços e voltar à janela "Plano de tarifa padrão".
- Para planos de taxas específicos de produtos de API, configure os detalhes do plano de taxas para outros produtos de API, conforme necessário.
Configurar o plano da 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.
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 criar o plano de tarifas. Você especifica 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 taxa fixa, especifique o seguinte nos detalhes do plano de tarifa:
- Um parâmetro de classificação que indica se 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 no 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 moeda "base" ou contábil usada pela sua empresa.
- Uma tarifa 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 tarifa do plano de tarifa.
Na taxa do plano de tarifas, você especifica:
- O tipo da tarifa do plano de preços (
RATECARD). - A taxa do plano. Por exemplo, se você especificar 0,10 e a moeda for dólar americano, o desenvolvedor vai receber uma cobrança de US $0,10 por transação. Se a cobrança for baseada 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 por transmitir o número especificado de bytes.
- A unidade inicial da aplicação da taxa (
0). Isso significa que a taxa é aplicada a cada transação, começando pela primeira.
Consulte Configurações de detalhes do plano de tarifas para ver uma lista completa de opções de detalhes do plano de tarifas.
Por exemplo, o comando a seguir cria um plano de tabela de preços com um modelo de cobrança fixa. A taxa é de US $0,10 por transação. O pagamento vence em 30 dias. Os detalhes relacionados à tabela de preços sã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 cobrança por faixa de volume
Em um modelo de faixa de volume, você especifica detalhes do plano de tarifas que incluem uma ou mais tarifas, cada uma delas aplicável a uma "faixa de volume", ou seja, um intervalo de volume de transações (ou um intervalo com base 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 tarifas do plano, você especifica o seguinte nos detalhes do plano:
- Um parâmetro de classificação que indica se 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, no estado em que se encontra, 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 usada pela sua empresa.
- Uma duração e um tipo de duração que especificam juntas 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 no período de agregação (por exemplo, um 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 do plano, especifique:
- O tipo da tarifa do plano de preços (
RATECARD). - A taxa do plano. Por exemplo, se você especificar 0,10 e a moeda for o dólar americano, o desenvolvedor vai receber uma cobrança de US $0,15 por transação. Se a cobrança for baseada 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 por transmitir o número de bytes especificado.
- 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. 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 para as primeiras 1.000 transações será de US$ 0,15. O desenvolvedor vai pagar US$ 0,15 por transação em 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 pacote 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 será aplicada a todas as transações após 1.000 transações no período de agregação.
Consulte Configurações de detalhes do plano de tarifas para ver uma lista completa de opções de detalhes do plano de tarifas.
Por exemplo, o comando 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 de agregação é de um mês. O pagamento vence em 30 dias. Os detalhes da tabela de preços sã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 cobrança em pacote
Em um modelo de cobrança agrupada, 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. 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 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 vai pagar US $50 (adiantado) por 1.000 transações em um mês. O desenvolvedor recebe a cobrança do valor definido, mesmo que o pacote não seja usado por completo. Após o término do período de agregação, o plano expira. Se o desenvolvedor quiser usar o pacote de novo, ele precisará comprar o plano (e o pacote) novamente.
O que você especifica nos detalhes do plano de tarifa é essencialmente o mesmo que especifica nos detalhes do plano de tarifa para o modelo de cobrança por faixa de volume. As diferenças são as seguintes:
- Cada plano de taxa especificado é para um pacote, 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 do plano de tarifas para ver uma lista completa de opções de detalhes do plano de tarifas.
Por exemplo, o comando 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 um 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 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, especifique 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 custo financeiro. O período pode ser baseado em um dos seguintes:
- Duração, ou seja, o tempo entre uma data de início da vigência e uma data de término.
- Quantidade, como o número de transações envolvendo o produto de API ou o volume referente 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 comando a seguir cria um plano de tabela de preços com um plano freemium com base em um volume de 5.000 unidades. 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