Configurer le plan tarifaire

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Introduction

Avec un tableau des tarifs, chaque transaction est facturée au développeur. Pour ce type de forfait, vous devez fournir des informations supplémentaires, telles que le modèle de facturation et le tarif de celui-ci.

Vous pouvez éventuellement spécifier un forfait freemium pour des produits spécifiques (plutôt que pour un package d'API). Vous ne pouvez le faire que pour un plan spécifique à un produit.

À quel moment les frais récurrents et les forfaits groupés sont-ils réinitialisés ?

Les plans tarifaires peuvent inclure des frais récurrents et des lots d'API (forfaits groupés et groupés), qui impliquent tous deux des frais spécifiques pendant lesquels des frais sont facturés et des forfaits groupés remis à zéro. Le tableau suivant décrit dans quels cas des frais récurrents sont facturés et le nombre de lots est réinitialisé. Si les applications de développement ne peuvent pas effectuer d'autres appels d'API parce qu'elles ont atteint une certaine limite de transaction, il s'agit des cas où le nombre d'appels d'API est réinitialisé et que les applications peuvent recommencer à effectuer des appels.

Si le plan comporte...	...ceci se produit
Des frais récurrents non nuls définis sur Mois Forfaits ou forfaits groupés	Les frais récurrents et la réinitialisation du forfait groupé sont effectués le premier du mois (par défaut). Pour définir une récurrence mensuelle à un jour spécifique, créez un plan tarifaire à l'aide de l'API de gestion et indiquez le jour avec une propriété RecurringStartUnit, comme décrit dans la section Créer des plans tarifaires à l'aide de l'API.
Des frais récurrents non nuls définis sur Semaine Forfaits ou forfaits groupés	Les frais récurrents et la réinitialisation du forfait d'offre groupée sont effectués tous les sept jours après la date de début du forfait du développeur.
Des frais récurrents non nuls définis sur Jour Forfaits ou forfaits groupés	Les frais récurrents et la réinitialisation du forfait d'offre groupée sont effectués tous les X jours après la date de début du forfait du développeur.
Aucuns frais récurrents (ou nuls) Forfaits ou forfaits groupés	Les forfaits d'offres groupées sont réinitialisés en fonction de la base d'agrégation définie dans le tableau des tarifs. Par exemple, si un développeur commence un plan tarifaire le 19 du mois et que la base d'agrégation est définie tous les mois, l'utilisation du bundle est réinitialisée le 19 de chaque mois. Notez que le jour du mois peut ne pas être le même. Par exemple, si un plan tarifaire commence le 31 décembre, la date de réinitialisation devient le 28 d'une année non bissextile, car il n'y a que 28 jours en février. Le 28 reste alors le jour de réinitialisation.

Configurer des plans de tableau des tarifs à l'aide de l'UI

Configurez les plans associés au tableau des tarifs en suivant la procédure ci-dessous.

Configurer le plan du tableau des tarifs à l'aide de l'API

Configurez les détails du plan tarifaire à l'aide de l'API, comme décrit dans les sections suivantes.

Spécification des détails du plan tarifaire à l'aide de l'API

Vous spécifiez les détails du plan tarifaire lors de la création du plan. Vous spécifiez les détails dans la propriété ratePlanDetails du corps de la requête lors d'un appel à /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. Ce que vous spécifiez dans la propriété ratePlanDetails dépend du modèle de facturation que vous choisissez : taux fixe, volume par bandes ou offres groupées.

Spécifier un modèle de facturation à taux fixe

Pour implémenter le modèle de facturation à taux fixe, vous devez spécifier les éléments suivants dans les détails du plan tarifaire:

• Paramètre de note indiquant que le plan tarifaire est basé sur les transactions (VOLUME) ou sur un attribut personnalisé (par exemple, MINT_CUSTOM_ATTRIBUTE_1). VOLUME est la valeur par défaut.
• Type de mesure (UNIT) qui indique que le tarif est fixe par unité (c'est-à-dire qu'il n'est pas basé sur le volume de transactions, comme c'est le cas pour le modèle de tarification par bandes ou par lots).
• Délai d'échéance du paiement (par exemple, 30 jours).
• ID de votre organisation.
• Devise de base ou comptable utilisée par votre entreprise.
• Tarif du plan tarifaire qui indique comment le tarif est calculé. Étant donné que le modèle de facturation est basé sur un tarif fixe, vous ne spécifiez qu'un seul tarif pour votre plan tarifaire.

Dans le champ "Tarif du plan tarifaire", vous indiquez:

• Type de tarif du plan tarifaire (RATECARD).
• Tarif du plan. Par exemple, si vous spécifiez 0,10 et que la devise est le dollar américain, le développeur est facturé 0,10 $pour chaque transaction (ou, si vous utilisez un attribut personnalisé comme le nombre d'octets transmis dans une transaction, le développeur est facturé 0,10 $pour la transmission du nombre d'octets spécifié).
• Unité de départ de l'application du tarif (0). Cela signifie que le tarif est appliqué à chaque transaction, en commençant par la première.

Consultez la section Paramètres de configuration des détails du plan tarifaire pour obtenir la liste complète des options de détails du plan tarifaire.

Par exemple, le code ci-dessous permet de créer un plan de tableau des tarifs avec un modèle de facturation fixe. Le taux est fixé à 0,10 $pour chaque transaction. Le paiement est dû dans 30 jours. Les informations relatives au tableau des tarifs sont mises en surbrillance.

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

Spécifier un modèle de charge par bandes de volume

Dans un modèle de volume en bandes, vous spécifiez les détails du plan tarifaire qui incluent un ou plusieurs tarifs, chaque tarif s'applique à une "bande de volume", c'est-à-dire une plage de volumes de transactions (ou une plage basée sur un attribut personnalisé tel que le nombre d'octets transmis). Ce type de plan est généralement mis en place pour encourager les développeurs à générer des volumes plus importants en proposant des tarifs réduits pour les bandes de volumes les plus importantes.

En plus des tarifs du plan tarifaire, vous spécifiez les éléments suivants dans les détails de celui-ci:

• Paramètre de note indiquant que le plan tarifaire est basé sur les transactions (VOLUME) ou sur un attribut personnalisé (par exemple, CUSTOM_ATTRIBUTE_1). VOLUME est la valeur par défaut.
• Un type de compteur (VOLUME) qui indique que le taux est basé sur le volume de transactions (c'est-à-dire qu'il ne s'agit pas d'un taux fixe par transaction, comme c'est le cas pour le modèle de facturation à taux fixe).
• Délai d'échéance du paiement (par exemple, 30 jours).
• ID de votre organisation.
• Devise de base ou comptable utilisée par votre entreprise.
• Type de durée et de durée qui spécifient ensemble la période pendant laquelle le volume de transactions (ou le volume lié à des attributs personnalisés) est agrégé. Ce processus est également appelé "base d'agrégation". Le volume de transactions est agrégé sur une base d'agrégation (par exemple, un mois) pour déterminer la bande de volume applicable.
• Compteurs d'agrégation utilisés pour déterminer la bande de volume applicable.

Pour chaque tarif de plan tarifaire, vous spécifiez:

• Type de tarif du plan tarifaire (RATECARD).
• Tarif du plan. Par exemple, si vous spécifiez 0,10 et que la devise est le dollar américain, le développeur est facturé 0,15 $pour chaque transaction (ou si vous utilisez un attribut personnalisé comme le nombre d'octets transmis dans une transaction, le développeur est facturé 0,15 $pour la transmission du nombre d'octets spécifié).
• Unité de début et de fin de la bande de volume. L'unité de début spécifie la limite inférieure de la bande de volume et l'unité de fin indique la limite supérieure de la bande de volume. Par exemple, si vous spécifiez une unité de départ de 0 et une unité de fin de 1 000, la bande de volume couvre jusqu'à 1 000 transactions au cours de la période d'agrégation. Si la devise est le dollar américain, la période d'agrégation est d'un mois et le taux des 1 000 premières transactions est de 0,15. Le développeur paie 0,15 $par transaction pour un maximum de 1 000 transactions dans le mois.
  
  Pour en savoir plus sur la réinitialisation des offres groupées, consultez Quand les frais récurrents sont-ils facturés et les forfaits groupés sont-ils réinitialisés ?
  

  Si vous ne spécifiez pas d'unité de fin pour la bande de volume finale, le taux de cette bande est appliqué à toutes les transactions une fois que le nombre de transactions a dépassé l'unité de départ pour cette bande. Par exemple, si l'unité de départ de la dernière bande est 1 000 et que vous ne spécifiez pas d'unité de fin pour celle-ci, le taux correspondant est appliqué à toutes les transactions effectuées après l'enregistrement de 1 000 transactions au cours de la période d'agrégation.

Consultez la section Paramètres de configuration des détails du plan tarifaire pour obtenir la liste complète des options de détails du plan tarifaire.

Par exemple, le code suivant permet de créer un plan de tableau des tarifs avec un modèle de tarification par bandes en fonction du volume. Le taux est fixé à 0,15 $pour les 1 000 premières transactions et à 0,10 $pour toutes les transactions supérieures à 1 000. La base d'agrégation est d'un mois. Le paiement est dû dans 30 jours. Les informations sur le tableau des tarifs sont mises en surbrillance.

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

Spécifier un modèle de recharge groupée

Dans un modèle de facturation groupée, le développeur paie (à l'avance) un "lot" de transactions (ou un lot basé sur un attribut personnalisé comme le nombre d'octets transmis). Vous spécifiez un tarif pour chaque groupe et une base d'agrégation, c'est-à-dire une période pendant laquelle le développeur peut utiliser le lot.

Par exemple, supposons que vous configuriez deux groupes, le premier groupe comprenant entre 1 et 1 000 transactions, et le second de 1 001 à 2 000 transactions. Le tarif est de 50 $pour le premier lot et de 40 $pour le deuxième. La base d'agrégation est de 1. Si le développeur achète un forfait pour le premier lot, il paie 50 $ (à l'avance) pour 1 000 transactions par mois. Le montant défini est facturé au développeur, que le bundle soit entièrement utilisé ou non. Une fois la période d'agrégation terminée, le plan expire. Si le développeur souhaite réutiliser l'offre groupée, il doit souscrire à nouveau le forfait (et l'offre groupée).

La valeur que vous spécifiez dans les détails du plan tarifaire est essentiellement la même que celle que vous spécifiez dans les détails du plan tarifaire pour le modèle de facturation par bandes en fonction du volume. Les différences sont les suivantes :

• Chaque plan tarifaire que vous spécifiez est destiné à un groupe (et non à une bande de volume).
• Vous devez spécifier une limite supérieure pour le dernier bundle, sauf si vous souhaitez facturer au développeur un montant fixe pour les transactions illimitées du dernier bundle.

Consultez la section Paramètres de configuration des détails du plan tarifaire pour obtenir la liste complète des options de détails du plan tarifaire.

Par exemple, le code suivant permet de créer un plan de tableau des tarifs avec un modèle de facturation groupée. Le tarif est fixé à 50 $pour le premier groupe (jusqu'à 1 000 transactions) et à 40 $pour le deuxième groupe (entre 1 000 et 2 000 transactions). La base d'agrégation est d'un mois. Le paiement est dû dans 30 jours.

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

Spécifier un plan freemium pour des produits individuels à l'aide de l'API

Dans un tableau des tarifs, vous pouvez configurer un plan freemium pour un produit individuel (plutôt que pour un package d'API). Un forfait freemium permet aux développeurs d'utiliser sans frais un produit d'API sur une période donnée ou en fonction de la quantité d'utilisation.

Lorsque vous définissez un forfait freemium pour un produit d'API, vous devez indiquer dans les détails du tableau des tarifs la période pendant laquelle le développeur peut utiliser sans frais les ressources fournies par le produit d'API. La période peut être basée sur l'un des éléments suivants:

• La durée, c'est-à-dire la période comprise entre une date d'entrée en vigueur et une date de fin.
• Quantité, telle que le nombre de transactions impliquant le produit d'API ou le volume relatif à un attribut personnalisé enregistré dans les règles d'enregistrement des transactions.

Si la période freemium est basée sur une quantité, spécifiez-la en tant qu'unités freemium. L'exemple ci-dessous permet de créer un plan de tableau des tarifs avec un plan freemium basé sur un volume de 5 000 unités (les spécifications concernant le freemium sont mises en surbrillance).

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