Você está lendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. info
Introdução
Em um plano de taxas, o desenvolvedor só paga as taxas do provedor de API especificadas no plano de taxas, como uma taxa de configuração única ou uma taxa de rescisão antecipada. Consulte Adicionar taxas a um plano de taxas para saber como especificar as taxas no plano. Não há outras taxas relacionadas à transação.
Ao criar o plano, você pode especificar os termos de renovação, ou seja, o período de renovação. A monetização renova automaticamente o plano no final do período de renovação, a menos que o desenvolvedor encerre o plano. Se o desenvolvedor encerrar um plano de taxas antes do prazo de renovação e uma taxa de rescisão antecipada estiver em vigor, essa taxa será cobrada do desenvolvedor.
Caixa de ferramentas
Você adiciona detalhes do plano de taxas usando a API de monetização. Para fazer isso, defina as propriedades relevantes no corpo da solicitação em uma chamada para o
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans recurso
(ao criar o plano de taxas).
Como especificar detalhes do plano de taxas usando a API
Você especifica os detalhes do plano de taxas ao criar o plano de taxas. Especifique os detalhes em o corpo da solicitação da chamada.
Por exemplo, o código a seguir cria um plano de taxas. O plano especifica uma taxa de rescisão antecipada (US$ 20), uma taxa de configuração (US$ 10) e uma taxa recorrente (US$ 5 por mês). As taxas vencem em 30 dias, e a taxa recorrente vence por completo (ou seja, não é proporcional). O prazo de renovação é de seis meses. As especificações relacionadas a taxas e as especificações de prazo de renovação são destacadas.
$ curl -H "Content-Type:application/json" -X POST -d \
'{
"name": "Standard fees only plan",
"advance": "false",
"contractDuration": "6",
"contractDurationType": "MONTH",
"currency": {
"id" : "usd"
},
"earlyTerminationFee": "20",
"description": "Standard fees only plan",
"displayName": "Standard fees only plan",
"frequencyDuration": 1,
"frequencyDurationType": "MONTH",
"monetizationPackage": {
"id": "location"
},
"organization": {
"id": "{org_name}"
},
"prorate": "false",
"paymentDueDays": "30",
"published": "true",
"ratePlanDetails": [],
"recurringFee": "5",
"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
Observe que a propriedade ratePlanDetails está vazia. Para um plano de taxas,
não há outros detalhes a serem fornecidos além das taxas e do período de renovação.
{ "advance" : false, "contractDuration" : 6, "contractDurationType" : "MONTH", "currency" : { "id" : "usd", "name" : "USD", ... "organization" : { ... }, ... }, "description" : "Standard fees only plan", "displayName" : "Standard fees only plan", "earlyTerminationFee" : 20, "freemiumDuration" : 0, "freemiumDurationType" : "MONTH", "freemiumUnit" : 0, "frequencyDuration" : 1, "frequencyDurationType" : "MONTH", "id" : "location_standard_fees_only_plan", "monetizationPackage" : { "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "Location", "organization" : { ... }, "product" : [ { "customAtt1Name" : "user", "description" : "Location", "displayName" : "Location", "id" : "location", "name" : "location", "organization" : { ... "status" : "CREATED" }, "name" : "Standard fees only plan", "organization" : { ... }, "paymentDueDays" : "30", "prorate" : false, "published" : false, "ratePlanDetails" : [ ], "recurringFee" : 5, "recurringStartUnit" : 1, "recurringType" : "CALENDAR", "setUpFee" : 10, "startDate" : "2013-07-30 00:00:00", "type" : "STANDARD" }
Consulte Plano de taxas configurações para uma lista completa de opções de plano de taxas.
Próximas etapas
Se quiser, adicione um plano freemium. Consulte Adicionar um plano freemium.
Depois de criar o plano de taxas e fornecer os detalhes dele, você poderá publicar o plano ou salvar como rascunho. Consulte Gerenciar e publicar planos de taxas para mais informações.