Vous consultez la documentation Apigee Edge.
Accédez à la
documentation**Apigee X**. info
Introduction
Dans un forfait avec frais, le développeur ne paie que les frais du fournisseur d'API spécifiés dans le plan tarifaire, tels que des frais d'installation uniques ou des frais de résiliation anticipée. (Pour savoir comment spécifier les frais dans le plan tarifaire, consultez Ajouter des frais à un plan tarifaire pour information.) Aucuns frais supplémentaires liés aux transactions ne sont facturés.
Lorsque vous créez le forfait, vous pouvez éventuellement spécifier les conditions de renouvellement, c'est-à-dire la période de renouvellement La monétisation renouvelle automatiquement le forfait à la fin de la période de renouvellement (sauf si le développeur résilie le forfait). Si le développeur résilie un plan tarifaire avant la période de renouvellement et que des frais de résiliation anticipée sont en vigueur, ces frais lui seront facturés.
Boîte à outils
Vous ajoutez les détails du forfait avec frais à l'aide de l'API de monétisation. Pour ce faire, définissez les propriétés pertinentes
dans le corps de la requête lors d'un appel à la
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans ressource
(lorsque vous créez le plan tarifaire).
Spécifier les détails du forfait avec frais à l'aide de l'API
Vous spécifiez les détails du forfait avec frais lorsque vous créez le plan tarifaire. Vous spécifiez les détails dans le corps de la requête de l'appel.
Par exemple, le code suivant crée un plan tarifaire avec frais. Le forfait spécifie des frais de résiliation anticipée (20 dollars américains), des frais d'installation (10 dollars américains), et des frais récurrents (5 dollars américains par mois). Les frais sont dus dans 30 jours, et les frais récurrents sont dus en totalité (c'est-à-dire, qu'ils ne sont pas calculés au prorata). La période de renouvellement est de six mois. (Les spécifications liées aux frais ainsi que les spécifications de la période de renouvellement sont mises en surbrillance.)
$ 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
Notez que la propriété ratePlanDetails est vide. Pour un plan tarifaire avec frais,
aucun autre détail n'est à fournir au-delà des frais et de la période de renouvellement.
{ "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" }
Pour obtenir la liste complète des options de plan tarifaire, consultez Rate plan configuration settings.
Étapes suivantes
Si vous le souhaitez, ajoutez un forfait freemium. Consultez Ajouter un forfait freemium.
Une fois que vous avez créé le plan tarifaire et fourni les détails du plan tarifaire, vous pouvez publier le plan ou l'enregistrer en tant que brouillon. Pour en savoir plus, consultez Gérer et publier des plans tarifaires.