Configurer le plan tarifaire

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info

Introduction

Dans un plan tarifaire, le développeur est facturé pour chaque transaction. Pour ce type de forfait, vous devez fournir des informations supplémentaires, telles que le modèle de facturation et les tarifs associés.

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

Quand les frais récurrents sont-ils facturés et quand les offres groupées sont-elles réinitialisées ?

Les plans tarifaires peuvent inclure des frais récurrents ainsi que des groupes d'API (plans Volume Banded et Bundle), qui impliquent tous deux des périodes spécifiques au moment des frais et des remises à zéro des groupes d'API. Le tableau suivant décrit le moment où des frais récurrents sont facturés et le nombre d'offres groupées est réinitialisé. Si les applications de développement ne peuvent plus effectuer d'appels d'API en raison d'une limite de transactions atteinte, les compteurs des appels d'API sont réinitialisés à zéro et les applications peuvent à nouveau effectuer des appels.

Si le plan comporte...	...cela se produit
Frais récurrents non nuls définis sur Mois Un forfait avec bandes de volume ou un forfait groupé	Les frais récurrents et le forfait groupé sont réinitialisés le premier du mois (par défaut). Pour une récurrence mensuelle à un jour spécifique, créez un plan tarifaire à l'aide de l'API de gestion et indiquez le jour à l'aide d'une propriété RecurringStartUnit, comme décrit dans la section Créer des plans tarifaires à l'aide de l'API.
Frais récurrents non nuls définis sur Semaine Un forfait avec bandes de volume ou un forfait groupé	Les frais récurrents et le forfait sont réinitialisés tous les sept jours après la date de début du plan tarifaire du développeur.
Des frais récurrents non nuls définis sur Jour un forfait avec bandes audio ou vidéo entière ;	Les frais récurrents et le forfait sont réinitialisés tous les X jours après la date de début du plan tarifaire du développeur.
Aucuns frais récurrents (ou 0 $) Un forfait avec bandes de volume ou un forfait groupé	Les forfaits sont réinitialisés en fonction de la base d'agrégation définie sur la fiche tarifaire. Par exemple, si un développeur commence un forfait le 19 du mois et que la base d'agrégation est de 1 mois, l'utilisation du lot est réinitialisée tous les mois le 19. Notez que le jour du mois peut ne pas toujours être le même. Par exemple, si un tarif commence le 31 décembre, la date de réinitialisation devient le 28 février d'une année non bissextile, car février ne compte que 28 jours. Le 28 reste alors le jour de réinitialisation.

Configurer des forfaits à l'aide de l'interface utilisateur

Configurez les plans de la carte tarifaire, comme décrit ci-dessous.

Configurer le plan de la carte tarifaire à 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écifier les détails d'un plan de tableau des tarifs à l'aide de l'API

Vous spécifiez les détails du plan tarifaire lorsque vous le créez. Vous spécifiez les détails dans la propriété ratePlanDetails dans le corps de la requête dans 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 : tarif forfaitaire, volume groupé ou bundles.

Spécifier un modèle de tarification forfaitaire

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

• Paramètre de classification 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 facturation (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 facturation par bande de volume ou par lot).
• La période de paiement à régler (par exemple, 30 jours).
• ID de votre organisation.
• Devise de base ou comptable utilisée par votre entreprise.
• Tarif d'un forfait qui fournit des informations sur son calcul. Étant donné que le modèle de facturation est basé sur un tarif fixe, vous ne spécifiez qu'un seul tarif de plan tarifaire.

Dans le tarif du plan tarifaire, vous devez spécifier les éléments suivants:

• Type de tarif du plan tarifaire (RATECARD).
• Tarif du forfait. Par exemple, si vous spécifiez 0,10 et que la devise est le dollar américain, le développeur paie 0,10 $pour chaque transaction (ou, s'il se base sur un attribut personnalisé tel que 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, à partir de la première.

Consultez Paramètres de configuration des détails des plans tarifaires pour obtenir la liste complète des options correspondantes.

Par exemple, le code suivant crée un forfait avec un modèle de facturation fixe. Le tarif est fixé à 0,10 $par transaction. Le paiement est dû dans 30 jours. (Les informations liées au tarif sont mises en évidence.)

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 recharge en bandes de volume

Dans un modèle à bandes de volume, 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 volume de transactions (ou une plage basée sur un attribut personnalisé tel que le nombre d'octets transmis). Ce type de forfait est généralement configuré pour encourager les développeurs à générer des volumes plus élevés en proposant des tarifs réduits pour les tranches de volume plus élevées.

En plus des tarifs du plan tarifaire, vous devez spécifier les éléments suivants dans les détails du plan tarifaire:

• Paramètre de classification 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 mesure (VOLUME) qui indique que le tarif 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 tarification forfaitaire).
• La période de paiement à régler (par exemple, 30 jours).
• ID de votre organisation.
• Il s'agit de la devise de base ou comptable utilisée par votre entreprise.
• Durée et type de durée qui spécifient ensemble la période sur laquelle le volume de transactions (ou le volume lié à un attribut personnalisé) est agrégé. On parle également de "base d'agrégation". Le volume des transactions est agrégé sur la 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 du plan tarifaire, vous devez spécifier les éléments suivants:

• Type du tarif du plan tarifaire (RATECARD).
• Tarif du forfait. 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, s'il est basé sur un attribut personnalisé tel que 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épart spécifie la limite inférieure de la bande de volume, et l'unité de fin spécifie 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 pour les 1 000 premières transactions est de 0,15, le développeur est facturé 0,15 $par transaction pour un maximum de 1 000 transactions par mois.
  
  Pour savoir quand les lots sont réinitialisés, consultez Quand les frais récurrents sont-ils facturés et les forfaits groupés réinitialisés ?.
  

  Si vous ne spécifiez pas d'unité de fin pour la dernière tranche de volume, le tarif de cette tranche s'applique à toutes les transactions une fois que le nombre de transactions a dépassé l'unité de départ de cette tranche. Par exemple, si l'unité de départ de la dernière tranche est 1 000 et que vous ne spécifiez pas d'unité de fin pour cette tranche, le tarif de la tranche s'applique à toutes les transactions après 1 000 transactions au cours de la période d'agrégation.

Pour obtenir la liste complète des options de configuration des détails du forfait, consultez la section Paramètres de configuration des détails du forfait.

Par exemple, le code suivant crée un forfait avec un modèle de tarification par tranche de volume. Le tarif est fixé à 0,15 $pour les 1 000 premières transactions et à 0,10 $pour toutes les transactions de plus de 1 000. La base d'agrégation est de 1 mois. Le paiement est dû dans 30 jours. (Les détails du tableau des tarifs sont mis 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 "groupe" de transactions (ou un groupe basé sur un attribut personnalisé tel que le nombre d'octets transmis). Vous spécifiez un tarif pour chaque lot 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 bundles, dont la première taille est de 1 à 1 000 transactions et la seconde de 1 001 à 2 000 transactions. Le tarif est de 50 $pour le premier lot et de 40 $pour le second lot, et la base d'agrégation est de 1. Si le développeur souscrit un forfait de tarifs pour le premier lot, il paie 50 $ (à l'avance) pour 1 000 transactions par mois. Le développeur est facturé du montant défini, que le lot soit entièrement utilisé ou non. Une fois la période d'agrégation terminée, le forfait expire. Si le développeur souhaite réutiliser le bundle, il devra racheter le forfait (et le bundle).

Ce que vous spécifiez dans les détails du plan tarifaire est essentiellement identique à ce que vous spécifiez dans les détails du plan tarifaire pour le modèle de tarification par tranche de volume. Les différences sont les suivantes :

• Chaque tarif que vous spécifiez est destiné à un lot (plutôt qu'à une plage 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 Paramètres de configuration des détails des plans tarifaires pour obtenir la liste complète des options correspondantes.

L'exemple ci-dessous permet de créer un tableau des tarifs avec un modèle de tarification groupée. Le tarif est fixé à 50 $pour le premier lot (jusqu'à 1 000 transactions) et à 40 $pour le deuxième lot (plus de 1 000 transactions et jusqu'à 2 000 transactions). La base d'agrégation est de 1 mois. Le paiement est dû dans les 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 forfait freemium pour des produits individuels à l'aide de l'API

Dans un plan tarifaire, vous pouvez configurer un plan freemium pour un produit individuel (plutôt que pour un package d'API). Avec le forfait freemium, les développeurs peuvent utiliser sans frais un produit d'API sur une période donnée ou en fonction de la quantité d'utilisation.

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

• Durée, c'est-à-dire la période entre une date d'entrée en vigueur et une date de fin.
• Quantité, comme le nombre de transactions impliquant le produit d'API ou le volume lié à un attribut personnalisé enregistré dans le règlement sur l'enregistrement des transactions.

Si la période de modèle freemium est basée sur la quantité, spécifiez-la en tant que nombre d'unités freemium. Par exemple, le code suivant crée un plan tarifaire avec un plan freemium basé sur un volume de 5 000 unités (les spécifications liées au 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