Configurer le plan tarifaire

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X.
En savoir plus

Introduction

Avec un tableau des tarifs, le développeur est facturé pour chaque transaction. Pour ce type de forfait, vous devez fournir des détails supplémentaires, tels que le modèle de facturation et son prix.

Vous pouvez éventuellement spécifier un forfait freemium pour des produits individuels (plutôt que pour une API). package), cela n'est possible 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 et des offres groupées d'API (forfaits basés sur le volume et groupés). qui impliquent un horaire spécifique auquel des frais sont facturés et où les offres groupées sont remises à zéro. La 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, car elles ont atteint un certain seuil limite de transaction, il s'agit des moments où le nombre d'appels d'API est remis à zéro et que les applications peut recommencer à passer des appels.

Si le plan comporte... ...ce qui arrive
  • Frais récurrents non nuls et définis sur Mois
  • un forfait avec bandes audio ou vidéo entière ;

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 donné, créez un plan tarifaire en utilisant le gestionnaire API 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 et définis sur Week
  • un forfait avec bandes audio ou vidéo entière ;
Les frais récurrents et le forfait sont réinitialisés tous les sept jours après le tarif du développeur la date de début du plan.
  • Des frais récurrents non nuls et définis sur Day
  • 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 le la date de début du plan tarifaire du développeur.
  • Aucuns frais récurrents (ou d'un montant nul)
  • un forfait avec bandes audio ou vidéo entière ;

Les forfaits groupés sont réinitialisés en fonction de la base d'agrégation définie dans le tableau des tarifs. Pour Par exemple, si un développeur commence un plan tarifaire le 19 du mois et que l'étape d'agrégation La base est définie sur un mois, puis l'utilisation du bundle est réinitialisée le 19 de chaque mois.

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 d'une année non bissextile, février, car il n'y a que 28 jours en février. Le 28 reste alors le jour de réinitialisation. au fil du temps.

Configurer des plans de tableau des tarifs à l'aide de la méthode UI (interface utilisateur)

Configurez les forfaits comme décrit ci-dessous.

Edge

Pour configurer un plan de tableau des tarifs lors de sa création ou de sa modification un plan tarifaire, sélectionnez le type de plan Tableau des tarifs ou Tableau des tarifs et part des revenus. Dans la section Tableau des tarifs, sélectionnez l'un des modèles de facturation suivants:

Modèle de recharge Description
Tarif forfaitaire Le développeur est facturé à un tarif fixe pour chaque transaction.
Volume avec bandes Le développeur est facturé à un tarif variable en fonction du volume de transactions.
Groupes Un montant fixe est facturé à l'avance au développeur pour chaque lot de transactions. Le développeur paie le montant défini, que l'offre soit utilisée intégralement ou non.

Remarque: Cette option n'est pas disponible lorsque vous sélectionnez "Tableau des tarifs" et "Part de revenus".

Configurez ensuite les informations suivantes en fonction du modèle de recharge sélectionné.

Modèle de recharge Champ Description
Tous Fréquence de calcul Période au cours de laquelle le volume de transactions (ou le volume lié à un attribut personnalisé) est calculé. Sélectionnez un nombre de mois (1 à 24 mois).
Tarif forfaitaire Taux fixe Tarif facturé pour chaque transaction. Saisissez un nombre décimal (comportant jusqu'à quatre chiffres après la virgule).

Remarque: Vous pouvez configurer le nombre de chiffres après la virgule qui peuvent être spécifiés pour le tarif facturé à l'aide de l'API (et non de l'interface utilisateur). Pour en savoir plus, consultez Configurer le nombre de chiffres après la virgule pour les tarifs du plan tarifaire.

Par exemple, si vous saisissez 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é).

Volume avec bandes Bandes de volume Une ou plusieurs plages de volumes de transactions (ou de volumes basés sur des attributs client) (chaque plage est une "bande de volume") pour le modèle de recharge par bandes de volume Un débit peut être attribué à chaque bande de volume. Le taux est appliqué à toutes les transactions dans la bande de volume applicable. Spécifiez la limite supérieure de la première bande, par exemple jusqu'à 1 000 (la limite inférieure est prédéfinie sur une valeur supérieure à 0).

Cliquez sur + Nouveau pour ajouter d'autres bracelets.

Laissez la limite supérieure de la dernière bande vide pour indiquer toutes les transactions au-dessus de ce niveau.

Remarque: Vous pouvez configurer le nombre de chiffres après la virgule qui peuvent être spécifiés pour le tarif facturé à l'aide de l'API (et non de l'interface utilisateur). Pour en savoir plus, consultez Configurer le nombre de chiffres après la virgule pour les tarifs du plan tarifaire.

Par exemple, si vous spécifiez deux bandes de volume dans la section Bande de volume (>0-1 000, 1 000 et au-dessus), vous pouvez saisir 0,15 pour la bande de volume >0 à 1 000 et 0,10 pour la bande de volume 1 000 et au-dessus. Si la devise sélectionnée est le dollar américain, le taux pour les 1 000 premières transactions est de 0,15 $pour chaque transaction. Pour plus de 1 000 transactions, il est de 0,10 $.

Groupes Prix des lots d'API Nombre de transactions dans un lot (ou nombre associé à un attribut personnalisé, comme le nombre total d'octets transmis dans un lot). Chaque lot peut se voir attribuer un prix. Le prix s'applique à l'ensemble du lot. Spécifiez la limite supérieure du premier groupe, par exemple jusqu'à 1 000 (la limite inférieure est prédéfinie sur une valeur supérieure à 0).

Cliquez sur + Nouveau pour ajouter d'autres groupes. 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.

Remarque: Vous pouvez configurer le nombre de chiffres après la virgule qui peuvent être spécifiés pour le tarif facturé à l'aide de l'API (et non de l'interface utilisateur). Pour en savoir plus, consultez Configurer le nombre de chiffres après la virgule pour les tarifs du plan tarifaire.

Par exemple, si vous spécifiez deux groupes dans la section Taille du bundle (supérieur à 0 à 1 000, et supérieur à 1 000 jusqu'à 2 000), vous pouvez saisir 50 pour le groupe supérieur à 0 à 1 000 et 40 pour le groupe supérieur à 1 000 à 2 000. Si la devise sélectionnée est le dollar américain, le prix du premier lot est de 50 $et celui du deuxième est de 40 $. Le développeur est facturé au prix de l'offre groupée applicable, quel que soit le nombre de transactions qu'il utilise dans l'offre groupée (le prix du lot est donc facturé au développeur dès que la première transaction de l'offre est terminée).

Si vous avez défini des attributs personnalisés pour votre produit API, vous pouvez configurer un paramètre de note personnalisée pour facturer le développeur de l'application en fonction d'un attribut personnalisé dans chaque transaction. Par exemple, si vous configurez un forfait dans lequel vous facturez le développeur pour chaque transaction, vous pouvez définir le tarif du forfait en fonction d'un attribut personnalisé, tel que le nombre d'octets transmis sur le backend, qui peut varier d'une transaction à l'autre.

Dans ce cas, sélectionnez Utiliser un paramètre de note personnalisée, puis sélectionnez l'attribut personnalisé dans la liste déroulante. Pour en savoir plus, consultez Configurer un plan tarifaire avec des attributs personnalisés.

Classic Edge (cloud privé)

Pour configurer des plans de tableau des tarifs à l'aide de l'interface utilisateur Classic Edge:

  1. Suivez les étapes pour créer un plan tarifaire.
  2. Dans la liste déroulante "Type de plan tarifaire", sélectionnez Tableau des tarifs pour configurer le modèle de revenus.
  3. Si le package d'API sélectionné inclut plusieurs produits d'API, choisissez l'une des options suivantes:

    Remarque: Si le package d'API inclut un seul produit d'API, vous pouvez ignorer cette étape.

    • Forfaits spécifiques au produit pour configurer les détails des plans tarifaires individuellement pour chaque produit d'API.
    • Forfait générique pour tous les produits : permet de configurer les détails du plan tarifaire pour tous les produits d'API.
  4. Cliquez sur Tableau des tarifs pour le plan tarifaire générique ou pour chaque plan tarifaire spécifique au produit d'API.

    Remarque: Lorsque vous configurez des plans spécifiques aux produits d'API, vous devez définir un plan de tableau des tarifs. pour chaque produit API.

    La fenêtre "Tableau des tarifs" s'ouvre.

  5. configurer un forfait freemium pour un produit d'API ; Avec le forfait freemium, les développeurs peuvent utiliser sans frais produit d'API sur une période donnée ou en fonction de la quantité d'utilisation.

    Saisissez les informations suivantes :

    Champ Description
    Produit Freemium ?

    Durée de la période sans frais. Sélectionnez l'une des cases d'option suivantes:

    • Par quantité. La période sans frais est basée sur une quantité spécifiée dans le volume. .
    • Par durée. La période des frais est basée sur un intervalle de temps spécifié dans les Freemium Duration.
    • selon la situation qui se présente en premier. La période sans frais se termine lorsque la quantité indiquée dans le le champ Volume ou l'intervalle de temps dans le champ Freemium Duration est atteint selon la situation qui se présente en premier.
    • Non, il ne s'agit pas d'un forfait freemium. Il s'agit de la valeur par défaut.
    Volume freemium

    Le volume de transactions (ou le volume relatif à un attribut personnalisé enregistré dans la règle d'enregistrement des transactions) qui ne sont pas facturées aux développeurs. Le volume est mesurées pour le produit API. Saisissez un chiffre pour le volume, par exemple 5 000. Cela signifie que Lorsque les développeurs commencent à utiliser le forfait, les 5 000 premières transactions ne leur sont pas facturées (ou pour les 5 000 premières utilisations d'un article associé à un attribut personnalisé). Ce champ est activé uniquement si vous sélectionnez "Par quantité" ou "selon la première échéance" dans le cadre du modèle "Freemium", Produit ?" .

    Durée du freemium

    Intervalle de temps pendant lequel les développeurs ne sont pas facturés. Saisissez un nombre et sélectionnez une période, par exemple "1 mois". Cela signifie que les développeurs facturés pendant 1 mois. Ce champ n'est activé que si vous sélectionnez "Par durée" ou "Selon la situation qui se présente en premier" dans le produit "freemium" ? .

  6. Sélectionnez l'un des modèles de recharge suivants: <ph type="x-smartling-placeholder">
      </ph>
    • Taux fixe. Dans ce modèle, le développeur paie un tarif fixe pour chaque transaction.
    • Volume avec bandes. Dans ce modèle, le développeur est facturé à un tarif variable en fonction du du volume de transactions.
    • Groupes. Dans ce modèle, le développeur paie un montant défini (à l'avance) pour chaque un groupe de transactions. Le développeur paie le montant défini, qu'il s'agisse ou non de l'offre est entièrement utilisé.

    Pour le modèle de tarification forfaitaire:saisissez les informations suivantes dans la section "Tarification" de pour la fenêtre "Tableau des tarifs générique" :

    Champ Description
    Opérateur (ou organisation)

    Nom de votre organisation. Ce champ est prédéfini à l'aide de l'opérateur (ou Organization) dans le profil d'organisation.

    Pays

    Pays d'activité de votre organisation. Ce champ est prédéfini à l'aide du paramètre Valeur du champ "Pays" dans le profil de l'organisation.

    Tarif forfaitaire

    Tarif appliqué pour chaque transaction. Saisissez un nombre décimal (comportant jusqu'à quatre décimales).

    Remarque: Vous pouvez configurer le nombre de décimales pouvant être spécifiées. pour le tarif facturé à l'aide de l'API (et non de l'UI). Pour plus d'informations, consultez la section Configurer le nombre de décimales pour les tarifs du plan tarifaire.

    Par exemple, si vous saisissez 0, 10 et que la devise est le dollar américain, le développeur est facturée 0,10 € par transaction (ou si les données sont basées sur un attribut personnalisé tel que le d'octets transmis dans une transaction, le développeur paie 0,10 $pour en transmettant le nombre d'octets spécifié).

    Pour le modèle en bandes de volume:la fenêtre "Tableau des tarifs générique" affiche qui servent à spécifier une base pour l'agrégation et des "bandes de volumes", qui des plages de volumes de transactions auxquelles vous pouvez appliquer différents tarifs.

    Ce type de plan 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 bandes de volume plus important.

    Dans la fenêtre "Tableau des tarifs générique", saisissez les informations suivantes:

    Champ Description
    Base d'agrégation

    Période au cours de laquelle le volume de transactions (ou les transactions (volume lié aux attributs) est agrégée. Le volume agrégé sert à identifier la bande de volume et le tarif à appliquer à chaque transaction. Sélectionnez un nombre de mois (1 à 12 mois).

    Pour en savoir plus sur la réinitialisation des groupes, consultez la section Cas de réinitialisation et que les forfaits groupés ont été réinitialisés ?

    Bandes de volume

    Une ou plusieurs plages de volumes de transactions (ou de volumes basés sur des attributs client) (chaque plage est une "bande de volume"). Un débit peut être attribué à chaque bande de volume (vous définissez ce débit dans le champ Bandes de volume de la section Tarification.) Le tarif s'applique à toutes les transactions dans la bande de volume applicable. Spécifiez la limite supérieure de la première jusqu'à 1 000, par exemple (la limite inférieure est prédéfinie sur une valeur supérieure à 0). Cliquez sur + pour ajouter une deuxième bande, par exemple, supérieure à 1 000 jusqu'à 2 000. Cliquez sur "+" pour en ajouter d'autres bracelets. Vous pouvez laisser la limite supérieure de la dernière bande vide pour indiquer toutes les transactions au-dessus de ce niveau.

    Tarifs
    Opérateur (ou organisation)

    Nom de votre organisation. Ce champ est prédéfini à l'aide de l'opérateur (ou Organization) dans le profil de l'organisation.

    Pays

    Pays d'activité de votre organisation. Ce champ est prédéfini à l'aide du paramètre Valeur du champ "Pays" dans le profil de l'organisation.

    Devise

    La "base" ou la devise comptable utilisée par votre organisation. Ce champ est est prédéfini à l'aide de la valeur du champ "Devise" dans le profil de l'organisation. modifié ici.

    Bandes de volume

    Débit pour une bande de volume. Vous spécifiez un débit pour chaque bande de volume. Saisissez un un nombre décimal pour chaque bande (jusqu'à quatre décimales).

    Remarque: Vous pouvez configurer le nombre de décimales pouvant être spécifiées. pour le débit de bande de volume à l'aide de l'API (et non de l'UI). Pour en savoir plus, consultez la section Configurer le nombre de décimales pour les tarifs du plan tarifaire.

    Par exemple, si vous spécifiez deux bandes de volume dans la section Bande de volume (> 0 à 1 000, et 1 000 et plus), vous pouvez saisir 0,15 pour le volume compris entre 0 et 1 000. et 0, 10 pour la bande de volume 1000 et au-dessus. Si la devise sélectionnée est les États-Unis le dollar américain, le taux pour les 1 000 premières transactions est de 0,15 $pour chaque transaction, et Pour plus de 1 000 transactions, le tarif est de 0,10 $par transaction.

    Pour le modèle groupé:la fenêtre "Tableau des tarifs générique" affiche des champs supplémentaires qui que vous utilisez pour spécifier une base d'agrégation (la période pendant laquelle le développeur peut utiliser le lot de transactions) et spécifier des informations sur le groupe, comme la taille d'un d'un bundle.

    Dans la fenêtre "Tableau des tarifs générique", saisissez les informations suivantes:

    Champ Description
    Base d'agrégation

    Période pendant laquelle le développeur peut utiliser le lot de transactions (ou utilisez un lot basé sur des attributs personnalisés). Sélectionnez un nombre de mois (1 à 12 mois). Après cette période, le forfait expire, et le développeur doit souscrire le forfait (et les offres groupées) à nouveau.

    Pour en savoir plus sur la réinitialisation des groupes, consultez la section Cas de réinitialisation et que les forfaits groupés ont été réinitialisés ?

    Taille du pack

    Nombre de transactions dans un lot (ou un nombre associé à un attribut personnalisé comme le nombre total d'octets transmis dans un bundle). Chaque lot peut être attribué Un prix (vous définissez ce prix dans le champ Taille du lot de la section "Prix") La le prix s'applique à l'ensemble du lot. Spécifiez la limite supérieure du premier groupe, par jusqu'à 1 000 (la limite inférieure est prédéfinie sur une valeur supérieure à 0). Cliquez sur "+" pour ajouter un un deuxième groupe, par exemple supérieur à 1 000 jusqu'à 2 000. Cliquez sur "+" pour en ajouter d'autres des offres groupées. Vous devez spécifier une limite supérieure pour le dernier groupe, sauf si vous souhaitez facturer au développeur un montant fixe pour des transactions illimitées sur les d'un bundle.

    Tarifs
    Opérateur (ou organisation)

    Nom de votre organisation. Ce champ est prédéfini à l'aide de l'opérateur (ou Organization) dans le profil de l'organisation.

    Pays

    Pays d'activité de votre organisation. Ce champ est prédéfini à l'aide du paramètre Valeur du champ "Pays" dans le profil de l'organisation.

    Devise

    La "base" ou la devise comptable utilisée par votre organisation. Ce champ est est prédéfini à l'aide de la valeur du champ "Devise" dans le profil de l'organisation. modifié ici.

    Taille du lot (prix)

    Prix d'un pack. Vous indiquez un prix pour chaque lot. Saisissez un nombre décimal (avec quatre chiffres maximum après la virgule).

    Remarque: Vous pouvez configurer le nombre de décimales pouvant être spécifiées. pour le tarif d'une offre groupée à l'aide de l'API (et non de l'UI). Pour en savoir plus, consultez la section Configurer le nombre de décimales pour les tarifs du plan tarifaire.

    Par exemple, si vous spécifiez deux groupes dans la section Taille du groupe (supérieur à 0 entre 1 000 et 1 000, et 1 000 jusqu'à 2 000), vous pouvez saisir 50 pour la valeur compris entre 0 et 1 000, et 40 pour un groupe de plus de 1 000 à 2 000. Si le la devise sélectionnée est le dollar américain, le prix du premier lot est de 50 USD et, pour les la deuxième offre, son prix est de 40 €. Le prix de l'offre groupée applicable est facturé au développeur quel que soit le nombre de transactions qu'ils utilisent dans le bundle (c'est-à-dire Le prix de l'offre est facturé au développeur dès la première transaction dans l'offre est terminée).

  7. Cliquez sur Appliquer et fermer pour enregistrer les informations du tableau des tarifs et revenir au plan tarifaire standard. fenêtre.
  8. Pour les plans tarifaires spécifiques aux produits d'API, configurez leurs détails pour les autres produits d'API, si nécessaire.

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

Configurez les détails du plan du tableau des tarifs à 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 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 de /organizations/{org_name}/monetization-packages/{package_id}/rate-plans Ce que vous spécifier dans la propriété ratePlanDetails, selon le modèle de facturation que vous choisissez: les tarifs forfaitaires, les bandes de volume ou les lots.

Spécifier un modèle de facturation forfaitaire

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

  • Paramètre de notation indiquant que le plan tarifaire est basé sur des transactions (VOLUME) ou en fonction d'un attribut personnalisé (par exemple, MINT_CUSTOM_ATTRIBUTE_1). VOLUME est la valeur par défaut.
  • Un type de mesure (UNIT) qui indique que le tarif est fixe par unité (qui n'est pas basée sur le volume de transactions, comme c'est le cas pour le volume modèle de charge des lots).
  • Délai d'échéance du paiement (par exemple, 30 jours).
  • ID de votre organisation.
  • La "base" ou la devise comptable utilisée par votre entreprise.
  • Tarif du plan tarifaire qui fournit des détails sur le calcul du tarif. En effet, est basé sur un tarif fixe, vous ne pouvez spécifier qu'un seul tarif.

Dans le tarif du plan tarifaire, vous indiquez:

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

Voir Plan tarifaire paramètres de configuration des détails du plan tarifaire pour obtenir la liste complète des options de détails du plan tarifaire.

L'exemple suivant permet de créer un plan de tableau des tarifs avec un modèle de facturation fixe. Le taux est de de 0,10 $pour chaque transaction. Le paiement doit être effectué sous 30 jours. (Les informations concernant le tableau des tarifs sont highlighted.)

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 à bande de volume

Dans un modèle en bandes de volume, vous spécifiez les détails du plan tarifaire qui incluent un ou plusieurs plans tarifaires. chaque taux s'applique à une "bande de volume", c'est-à-dire à une plage de volumes de transactions en fonction d'un attribut personnalisé tel que le nombre d'octets transmis). Ce type de plan 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 bandes de volume plus élevé.

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

  • Paramètre de notation indiquant que le plan tarifaire est basé sur des transactions (VOLUME) ou en fonction d'un attribut personnalisé (par exemple, CUSTOM_ATTRIBUTE_1). VOLUME est la valeur par défaut.
  • Un type de mesure (VOLUME) indiquant que le tarif est basé sur le volume (il ne s'agit pas d'un taux fixe par transaction, comme c'est le cas pour le modèle de tarification forfaitaire).
  • Délai d'échéance du paiement (par exemple, 30 jours).
  • ID de votre organisation.
  • La "base" ou la devise comptable utilisée par votre entreprise.
  • Un type de durée et un type de durée qui, ensemble, spécifient la période sur laquelle le volume des transactions (ou le volume lié aux attributs personnalisés) est agrégée. Ceci est également appelé une "base d'agrégation". Le volume des transactions est agrégé sur la base d'agrégation (par exemple, 1 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 indiquez:

  • Type de tarif du plan tarifaire (RATECARD).
  • Tarif du plan. Par exemple, si vous indiquez 0, 10 et que la devise est le dollar américain, le développeur paie 0,15 € par transaction (ou si la valeur est basée sur un attribut personnalisé tel que le nombre d'octets transmis dans une transaction, le développeur paie 0,15 $pour en transmettant le nombre d'octets spécifié).
  • Unité de début et de fin de la bande de volume. L'unité de départ indique de la bande de volume, et l'unité de fin spécifie la limite supérieure de la bande de volume. Pour Par exemple, si vous spécifiez 0 comme unité de début et 1 000 comme unité de fin, la bande de volume couvre jusqu'à 1 000 transactions pendant la période d'agrégation. Si la devise est le dollar américain, la période d'agrégation est de 1 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 par mois.

    Pour en savoir plus sur la réinitialisation des offres groupées, consultez À quel moment des 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 bande de volume finale, le tarif pour cette bande est appliqué à toutes les transactions après que le nombre de transactions dépasse l'unité de départ pour ce groupe. Par exemple, si l'unité de départ de la dernière bande est 1 000 et que vous ne spécifie une unité de fin pour cette bande, le taux de celle-ci est appliqué à toutes les transactions après 1 000 transactions au cours de la période d'agrégation.

Voir Plan tarifaire paramètres de configuration des détails du plan tarifaire pour obtenir la liste complète des options de détails du plan tarifaire.

L'exemple suivant permet de créer un plan de tableau des tarifs avec un modèle de facturation en bande de volume. La est fixé à 0,15 $pour les 1 000 premières transactions et à 0,10 $pour toutes les transactions supérieures à 1 000. Elle est calculée sur la base d'un mois. Le paiement doit être effectué sous 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 avec recharge groupée

Dans un modèle de recharge groupée, le développeur paie (à l'avance) un "lot" de transactions (ou pour un lot en fonction d'un attribut personnalisé tel que le nombre d'octets transmis). Vous spécifiez un pour chaque lot ainsi qu'une base d'agrégation, c'est-à-dire une période pendant laquelle le développeur peuvent utiliser le bundle.

Par exemple, supposons que vous configuriez deux groupes, où la taille du premier est comprise entre 1 et 1 000 transactions, et une seconde taille de paquet est compris entre 1 001 et 2 000 transactions. Le tarif est de 50 $pour premier lot et 40 $pour le second. La base d'agrégation est de 1. Si le développeur achète un plan de tableau des tarifs pour le premier lot, paie 50 $ (d'avance) pour 1 000 transactions par mois. Le développeur paie le montant défini, que l'offre soit entièrement utilisée ou non. À la fin de la période d'agrégation, le plan expire. Si le développeur souhaite utiliser le bundle à nouveau, il doit souscrire à nouveau le forfait (et l'offre groupée).

Les informations que vous indiquez dans les détails du plan tarifaire sont essentiellement les mêmes que celles que vous indiquez dans le champ détails du plan tarifaire pour le modèle de facturation par bandes de volume. Les différences sont les suivantes :

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

Voir Plan tarifaire paramètres de configuration des détails du plan tarifaire pour obtenir la liste complète des options de détails du plan tarifaire.

L'exemple ci-dessous permet de créer un tableau des tarifs avec un modèle de tarification groupée. Le taux est de de 50 $pour le premier lot (jusqu'à 1 000 transactions) et de 40 $pour le deuxième entre 1 000 et 2 000 transactions). Elle est calculée sur la base d'un mois. Le paiement doit être effectué dans un délai de 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 avec tableau des tarifs, vous pouvez configurer un plan freemium pour un produit spécifique un package d'API). Avec un forfait freemium, les développeurs peuvent utiliser sans frais un produit d'API sur une période de en fonction de la durée ou de l'utilisation.

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

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

Si la période freemium est basée sur une quantité, spécifiez-la sous la forme d'un nombre d'unités freemium. Pour L'exemple suivant permet de créer un plan de tableau des tarifs avec un forfait freemium basé sur un volume de 5 000 unités (les spécifications liées au freemium sont mises en évidence)

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