Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X.
Introduction
Dans un plan avec grille tarifaire, le développeur est facturé pour chaque transaction. Pour ce type de forfait, vous devez fournir des informations supplémentaires, comme le modèle de facturation et son prix.
Vous pouvez également 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 à un produit.
Quand les frais récurrents sont-ils facturés et les forfaits réinitialisés ?
Les plans tarifaires peuvent inclure des frais récurrents ainsi que des forfaits d'API (plans à volume échelonné et plans groupés), qui impliquent tous deux des moments spécifiques où les frais sont facturés et où les plans groupés sont réinitialisés à zéro. Le tableau suivant décrit le moment où les frais récurrents sont facturés et où le nombre de forfaits est réinitialisé. Si les applications de développeur sont bloquées et ne peuvent plus effectuer d'appels d'API, car elles ont atteint une certaine limite de transactions, voici les moments où le nombre d'appels d'API est réinitialisé à zéro et où les applications peuvent de nouveau effectuer des appels.
| Si le forfait comporte… | …this happens |
|---|---|
|
La réinitialisation des frais récurrents et du forfait a lieu le premier jour du mois (par défaut). Pour une récurrence mensuelle à un jour spécifique, créez un plan tarifaire à l'aide de l'API Management et indiquez le jour avec une propriété |
|
Les frais récurrents et la réinitialisation du forfait ont lieu tous les sept jours à compter de la date de début du plan tarifaire du développeur. |
|
Les frais récurrents et la réinitialisation du forfait ont lieu tous les X jours après la date de début du plan tarifaire du développeur. |
|
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 d'un mois, l'utilisation du forfait est réinitialisée tous les mois le 19. Notez que le jour du mois peut ne pas être le même à chaque fois. Par exemple, si un forfait commence le 31 décembre, la date de réinitialisation devient le 28 février les années non bissextiles, car le mois de février ne compte que 28 jours. Le 28 devient alors le jour de réinitialisation pour toujours. |
Configurer des forfaits avec grille tarifaire à l'aide de l'interface utilisateur
Configurez les plans de la grille tarifaire, comme décrit ci-dessous.
Edge
Pour configurer un plan tarifaire, lorsque vous créez ou modifiez un plan tarifaire, sélectionnez le type de plan tarifaire Tableau des tarifs ou Tableau des tarifs et partage 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 | Un tarif fixe est facturé au développeur pour chaque transaction. |
| Volume avec cordon | Le développeur est facturé à un taux variable en fonction du volume de transactions. |
| Groupes | Un montant fixe est facturé au développeur à l'avance pour chaque groupe de transactions. Le développeur est facturé du montant défini, que le pack soit utilisé en totalité ou non.
Remarque : Cette option n'est pas disponible lorsque vous sélectionnez "Tarif et partage des revenus". |
Configurez ensuite les informations suivantes en fonction du modèle de facturation sélectionné.
| Modèle de facturation | Champ | Description |
| Tous | Fréquence de calcul | Période pendant laquelle le volume de transactions (ou le volume associé à un attribut personnalisé) est calculé. Sélectionnez un nombre de mois (entre 1 et 24). |
| Tarif forfaitaire | Taux fixe | Taux facturé pour chaque transaction. Saisissez un nombre décimal (avec jusqu'à quatre décimales).
Remarque : Vous pouvez configurer le nombre de décimales pouvant être spécifié pour le taux facturé à l'aide de l'API (et non de l'interface utilisateur). Pour en savoir plus, consultez Configurer le nombre de décimales pour les tarifs des forfaits. Par exemple, si vous saisissez 0,10 et que la devise est le dollar américain, le développeur est facturé 0,10 $ pour chaque transaction (ou, si la facturation est basée sur un attribut personnalisé tel que le nombre d'octets transmis lors d'une transaction, le développeur est facturé 0,10 $ pour la transmission du nombre d'octets spécifié). |
| Volume avec cordon | Bandes de volume | Une ou plusieurs plages de volume de transactions (ou basées sur des attributs client) (chaque plage est une "tranche de volume") pour le modèle de facturation par tranche de volume. Un taux peut être attribué à chaque tranche de volume. Le taux s'applique à toutes les transactions de la tranche de volume concernée. 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 "supérieure à 0".
Cliquez sur + Nouveau pour ajouter des bandes. Laissez la limite supérieure de la dernière tranche vide pour indiquer toutes les transactions supérieures à ce niveau. Remarque : Vous pouvez configurer le nombre de décimales pouvant être spécifié pour le taux facturé à l'aide de l'API (et non de l'interface utilisateur). Pour en savoir plus, consultez Configurer le nombre de décimales pour les tarifs des forfaits. 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 la bande de volume > 0-1 000 et 0, 10 pour la bande de volume 1 000 et plus. Si la devise sélectionnée est le dollar américain, le taux est de 0, 15 $ par transaction pour les 1 000 premières transactions et de 0, 10 $ par transaction au-delà. |
| Groupes | Tarifs des bundles d'API | Nombre de transactions dans un bundle (ou nombre lié à un attribut personnalisé, tel que le nombre total d'octets transmis dans un bundle). Un prix peut être attribué à chaque pack. Le prix s'applique à l'ensemble du pack. Spécifiez la limite supérieure du premier groupe (par exemple, jusqu'à 1 000). La limite inférieure est prédéfinie sur "supérieure à 0".
Cliquez sur + Nouveau pour ajouter des packs. Vous devez spécifier une limite supérieure pour le dernier bundle, sauf si vous souhaitez facturer au développeur un montant fixe pour un nombre illimité de transactions dans le dernier bundle. Remarque : Vous pouvez configurer le nombre de décimales pouvant être spécifié pour le taux facturé à l'aide de l'API (et non de l'interface utilisateur). Pour en savoir plus, consultez Configurer le nombre de décimales pour les tarifs des forfaits. Par exemple, si vous spécifiez deux groupes dans la section "Taille du bundle" (de 0 à 1 000 et de 1 000 à 2 000), vous pouvez saisir 50 pour le groupe de 0 à 1 000 et 40 pour le groupe de 1 000 à 2 000. Si la devise sélectionnée est le dollar américain, le prix du premier bundle est de 50 $ et celui du second est de 40 $. Le développeur est facturé au prix du forfait applicable, quel que soit le nombre de transactions qu'il utilise dans le forfait (c'est-à-dire que le développeur est facturé au prix du forfait dès que la première transaction du forfait est effectuée). |
Si vous avez défini des attributs personnalisés pour votre produit d'API, vous pouvez configurer un paramètre de notation personnalisé pour facturer le développeur d'applications 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 selon la transaction.
Dans ce cas, sélectionnez Utiliser un paramètre de note personnalisé, puis sélectionnez l'attribut personnalisé dans la liste déroulante. Pour en savoir plus, consultez Configurer un forfait avec des attributs personnalisés.
Classic Edge (Private Cloud)
Pour configurer des plans de grille tarifaire à l'aide de l'interface utilisateur Classic Edge :
- Suivez la procédure pour créer un plan tarifaire.
- Sélectionnez Fiche tarifaire dans le menu déroulant "Type de forfait" pour configurer le modèle de revenus.
- Si le package d'API sélectionné inclut plusieurs produits d'API, sélectionnez l'une des options suivantes :
Remarque : Si le package d'API n'inclut qu'un seul produit d'API, vous pouvez ignorer cette étape.
- Plans spécifiques aux produits pour configurer les détails des plans tarifaires pour chaque produit d'API individuellement.
- Plan générique pour tous les produits : configurez les détails du plan tarifaire pour tous les produits d'API.
- Cliquez sur Tarif pour le plan tarifaire générique ou pour chaque plan tarifaire spécifique à un produit d'API.
Remarque : Lorsque vous configurez des forfaits spécifiques à un produit d'API, vous devez configurer un forfait de grille tarifaire pour chaque produit d'API individuellement.
La fenêtre "Tarif" s'ouvre.
- Configurez un forfait freemium pour un produit d'API. Un forfait freemium permet aux développeurs d'utiliser sans frais un produit d'API pendant 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 de 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 champ "Volume".
- Par durée. La période de frais est basée sur un intervalle de temps spécifié dans le champ "Durée du freemium".
- Le premier des deux. La période sans frais prend fin lorsque la quantité dans le champ "Volume" ou l'intervalle de temps dans le champ "Durée Freemium" est atteint, selon ce qui se produit en premier.
- Non, il ne s'agit pas d'un forfait freemium. Il s'agit de la valeur par défaut.
Volume Freemium Volume de transactions (ou volume lié à un attribut personnalisé enregistré dans le règlement sur l'enregistrement des transactions) pour lequel les développeurs ne sont pas facturés. Le volume est mesuré pour le produit d'API. Saisissez un nombre de volume, par exemple 5000. Cela signifie que lorsque les développeurs souscrivent au forfait, les 5 000 premières transactions (ou les 5 000 premières utilisations d'un élément lié à un attribut personnalisé) ne leur sont pas facturées. Ce champ n'est activé que si vous sélectionnez "Par quantité" ou "Au premier des deux termes échus" dans le champ "Produit freemium ?".
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 ne sont pas facturés pendant un mois. Ce champ n'est activé que si vous sélectionnez "Par durée" ou "Au premier terme échu" dans le champ "Produit freemium ?".
- Sélectionnez l'un des modèles de facturation suivants :
- Tarif forfaitaire Dans ce modèle, un tarif fixe est facturé au développeur pour chaque transaction.
- Volume par tranche Dans ce modèle, le développeur est facturé à un taux variable en fonction du volume de transactions.
- Packs. Dans ce modèle, le développeur est facturé d'un montant fixe (à l'avance) pour chaque ensemble de transactions. Le développeur est facturé du montant défini, que le forfait soit entièrement utilisé ou non.
Pour le modèle à tarif fixe : saisissez les informations suivantes dans la section "Tarification" de la fenêtre "Tarif générique" :
Champ Description Opérateur (ou organisation) Nom de votre organisation. Ce champ est prédéfini à l'aide de la valeur du champ "Opérateur" (ou "Organisation") dans le profil de l'organisation.
Pays Pays dans lequel votre organisation exerce ses activités. Ce champ est prédéfini à l'aide de la valeur du champ "Pays" dans le profil de l'organisation.
Tarif forfaitaire Taux facturé pour chaque transaction. Saisissez un nombre décimal (avec jusqu'à quatre décimales).
Remarque : Vous pouvez configurer le nombre de décimales pouvant être spécifié pour le taux facturé à l'aide de l'API (et non de l'interface utilisateur). Pour en savoir plus, consultez Configurer le nombre de décimales pour les tarifs des plans tarifaires.
Par exemple, si vous saisissez 0,10 et que la devise est le dollar américain, le développeur est facturé 0,10 $ pour chaque transaction (ou, si le prix est basé 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é).
Pour le modèle à bandes de volume : la fenêtre "Tableau des tarifs générique" affiche des champs supplémentaires que vous utilisez pour spécifier une base d'agrégation et des "bandes de volume", c'est-à-dire des plages de volume de transactions auxquelles vous pouvez appliquer différents tarifs.
Ce type de forfait est généralement conçu 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.
Saisissez les informations suivantes dans la fenêtre "Tarif générique" :
Champ Description Base d'agrégation Période pendant laquelle le volume de transactions (ou le volume associé à un attribut personnalisé) est agrégé. Le volume agrégé permet d'identifier la tranche de volume et le taux à appliquer à chaque transaction. Sélectionnez un nombre de mois (entre 1 et 12).
Pour savoir quand les forfaits sont réinitialisés, consultez Quand les frais récurrents et les forfaits sont-ils facturés et réinitialisés ?
Bandes de volume Une ou plusieurs plages de volume de transactions (ou basées sur les attributs client). Chaque plage est une "tranche de volume". Un tarif peut être attribué à chaque tranche de volume (vous définissez ce tarif dans le champ "Tranches de volume" de la section "Tarification"). Le taux s'applique à toutes les transactions de la tranche de volume concernée. 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 "supérieure à 0". Cliquez sur + pour ajouter une deuxième tranche, par exemple, de 1 000 à 2 000. Cliquez sur + pour ajouter d'autres bandes. Vous pouvez laisser la limite supérieure de la dernière tranche vide pour indiquer toutes les transactions supérieures à ce niveau.
Tarifs Opérateur (ou organisation) Nom de votre organisation. Ce champ est prédéfini à l'aide de la valeur du champ "Opérateur" (ou "Organisation") dans le profil de l'organisation.
Pays Pays dans lequel votre organisation exerce ses activités. Ce champ est prédéfini à l'aide de la valeur du champ "Pays" dans le profil de l'organisation.
Devise Devise de base ou comptable utilisée par votre organisation. Ce champ est prédéfini à l'aide de la valeur du champ "Devise" dans le profil de l'organisation, mais il peut être modifié ici.
Bandes de volume Tarif d'une tranche de volume. Vous spécifiez un taux pour chaque tranche de volume. Saisissez un nombre décimal pour chaque bande (avec jusqu'à quatre décimales).
Remarque : Vous pouvez configurer le nombre de décimales pouvant être spécifié pour le taux de tranche de volume à l'aide de l'API (et non de l'interface utilisateur). Pour en savoir plus, consultez Configurer le nombre de décimales pour les tarifs des plans tarifaires.
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 la bande de volume "> 0-1 000" et 0, 10 pour la bande de volume "1 000 et plus". Si la devise sélectionnée est le dollar américain, le tarif est de 0,15 $ par transaction pour les 1 000 premières transactions, et de 0,10 $ par transaction au-delà.
Pour le modèle groupé : la fenêtre "Fiche tarifaire générique" affiche des champs supplémentaires que vous utilisez pour spécifier une base d'agrégation (la période pendant laquelle le développeur peut utiliser le groupe de transactions) et pour spécifier des informations liées au groupe, telles que la taille d'un groupe.
Saisissez les informations suivantes dans la fenêtre "Tarif générique" :
Champ Description Base d'agrégation Période pendant laquelle le développeur peut utiliser le bundle de transactions (ou un bundle personnalisé basé sur des attributs). Sélectionnez un nombre de mois (entre 1 et 12). Après cette période, le forfait expire et le développeur doit l'acheter à nouveau (ainsi que les packs).
Pour savoir quand les forfaits sont réinitialisés, consultez Quand les frais récurrents et les forfaits sont-ils facturés et réinitialisés ?
Taille du bundle Nombre de transactions dans un bundle (ou nombre lié à un attribut personnalisé, tel que le nombre total d'octets transmis dans un bundle). Un prix peut être attribué à chaque pack (vous définissez ce prix dans le champ "Taille du pack" de la section "Tarification"). Le prix s'applique à l'ensemble du pack. Spécifiez la limite supérieure du premier bundle, par exemple jusqu'à 1 000 (la limite inférieure est prédéfinie sur "supérieure à 0"). Cliquez sur + pour ajouter un deuxième groupe (par exemple, de 1 000 à 2 000). Cliquez sur + pour ajouter d'autres packs. Vous devez spécifier une limite supérieure pour le dernier bundle, sauf si vous souhaitez facturer au développeur un montant fixe pour un nombre illimité de transactions dans le dernier bundle.
Tarifs Opérateur (ou organisation) Nom de votre organisation. Ce champ est prédéfini à l'aide de la valeur du champ "Opérateur" (ou "Organisation") dans le profil de l'organisation.
Pays Pays dans lequel votre organisation exerce ses activités. Ce champ est prédéfini à l'aide de la valeur du champ "Pays" dans le profil de l'organisation.
Devise Devise de base ou comptable utilisée par votre organisation. Ce champ est prédéfini à l'aide de la valeur du champ "Devise" dans le profil de l'organisation, mais il peut être modifié ici.
Taille du bundle (prix) Prix d'un bundle. Vous spécifiez un prix pour chaque pack. Saisissez un nombre décimal (avec jusqu'à quatre décimales).
Remarque : Vous pouvez configurer le nombre de décimales pouvant être spécifié pour le tarif groupé à l'aide de l'API (et non de l'interface utilisateur). Pour en savoir plus, consultez Configurer le nombre de décimales pour les tarifs des plans tarifaires.
Par exemple, si vous spécifiez deux groupes dans la section "Taille du groupe" (de 1 à 1 000 et de 1 001 à 2 000), vous pouvez saisir 50 pour le groupe de 1 à 1 000 et 40 pour le groupe de 1 001 à 2 000. Si la devise sélectionnée est le dollar américain, le prix du premier bundle est de 50 $ et celui du second est de 40 $. Le développeur est facturé au prix du forfait applicable, quel que soit le nombre de transactions qu'il utilise dans le forfait (c'est-à-dire que le développeur est facturé au prix du forfait dès que la première transaction du forfait est effectuée).
- Cliquez sur Appliquer et fermer pour enregistrer les informations sur la grille tarifaire et revenir à la fenêtre "Plan tarifaire standard".
- Pour les plans tarifaires spécifiques aux produits d'API, configurez les détails du plan tarifaire pour les produits d'API supplémentaires, si nécessaire.
Configurer le forfait avec grille tarifaire à l'aide de l'API
Configurez les détails du plan de la grille tarifaire à l'aide de l'API, comme décrit dans les sections suivantes.
Spécifier les détails du plan de la fiche tarifaire à l'aide de l'API
Vous spécifiez les détails du forfait de la grille tarifaire lorsque vous créez le plan tarifaire. 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 : tarif forfaitaire, par tranche de volume ou par forfait.
Spécifier un modèle de facturation à tarif fixe
Pour implémenter le modèle de facturation à tarif fixe, spécifiez les éléments suivants dans les détails du forfait :
- Paramètre de tarification qui indique que le plan tarifaire est basé sur les transactions (
VOLUME) ou sur un attribut personnalisé (par exemple,MINT_CUSTOM_ATTRIBUTE_1).VOLUMEest la valeur par défaut. - Type de mesure (
UNIT) indiquant 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 tranches de volume ou par packs). - La période de paiement (30 jours, par exemple).
- ID de votre organisation.
- Devise de base ou comptable utilisée par votre entreprise.
- Tarif d'un plan tarifaire qui fournit des informations sur la façon dont le tarif est calculé. Comme le modèle de facturation est basé sur un tarif fixe, vous ne spécifiez qu'un seul tarif de forfait.
Dans le tarif du plan tarifaire, vous spécifiez :
- Type de tarif du forfait (
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,10 $ pour chaque transaction (ou, si la facturation est basée 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 taux (
0). Cela signifie que le taux est appliqué à chaque transaction, en commençant par la première.
Pour obtenir la liste complète des options de détails du forfait, consultez Paramètres de configuration des détails du forfait.
Par exemple, le code suivant crée un forfait avec un modèle de facturation fixe. Le taux est fixé à 0,10 $ par transaction. Le paiement est dû dans les 30 jours. (Les détails liés au tableau des tarifs sont mis 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 tarification par tranche de volume
Dans un modèle à tranches de volume, vous spécifiez les détails du forfait, y compris un ou plusieurs tarifs. Chaque tarif s'applique à une "tranche 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 conçu 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 tarification qui indique que le plan tarifaire est basé sur les transactions (
VOLUME) ou sur un attribut personnalisé (par exemple,CUSTOM_ATTRIBUTE_1).VOLUMEest la valeur par défaut. - Type de mesure (
VOLUME) indiquant que le tarif est basé sur le volume de transactions (c'est-à-dire qu'il ne s'agit pas d'un tarif fixe par transaction, comme c'est le cas pour le modèle de facturation à tarif fixe). - La période de paiement (30 jours, par exemple).
- ID de votre organisation.
- Devise de base ou comptable utilisée par votre entreprise.
- Une durée et un type de durée qui spécifient ensemble la période pendant laquelle le volume de transactions (ou le volume associé à un attribut personnalisé) est agrégé. On parle également de "base d'agrégation". Le volume de transactions est agrégé sur la base d'agrégation (par exemple, un mois) pour déterminer la tranche de volume applicable.
- Compteurs d'agrégation utilisés pour déterminer la tranche de volume applicable.
Pour chaque tarif du plan tarifaire, vous devez spécifier les éléments suivants :
- Type de tarif du forfait (
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, si la facturation est basée sur un attribut personnalisé tel que le nombre d'octets transmis lors d'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 tranche de volume couvre jusqu'à 1 000 transactions au cours de la période d'agrégation. Si la devise est le dollar américain, que la période d'agrégation est d'un mois et que 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 au cours du mois.
Pour savoir quand les forfaits sont réinitialisés, consultez Quand les frais récurrents et les forfaits sont-ils facturés et réinitialisés ?
Si vous ne spécifiez pas d'unité de fin pour la tranche de volume final, le taux de cette tranche s'applique à toutes les transactions une fois que le nombre de transactions a dépassé l'unité de début de cette tranche. Par exemple, si l'unité de départ de la dernière tranche est de 1 000 et que vous ne spécifiez pas d'unité de fin pour cette tranche, le taux 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 détails du forfait, consultez 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 taux est fixé à 0,15 $ pour les 1 000 premières transactions et à 0,10 $ pour toutes les transactions au-delà de 1 000. La base d'agrégation est d'un mois. Le paiement est dû dans les 30 jours. (Les détails du tableau des tarifs sont mis en évidence.)
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 "pack" de transactions (ou un pack basé sur un attribut personnalisé tel que le nombre d'octets transmis). Vous spécifiez un taux pour chaque bundle et une base d'agrégation, c'est-à-dire une période pendant laquelle le développeur peut utiliser le bundle.
Par exemple, supposons que vous configurez deux groupes, où la taille du premier groupe est de 1 à 1 000 transactions et celle du deuxième groupe est de 1 001 à 2 000 transactions. Le tarif est de 50 $ pour le premier forfait et de 40 $ pour le second, et la base d'agrégation est de 1. Si le développeur souscrit un forfait avec grille tarifaire pour le premier bundle, il paie 50 $ (à l'avance) pour 1 000 transactions par mois. Le développeur est facturé du montant défini, que le forfait 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 doit souscrire à nouveau au forfait (et au 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 tranches de volume. Les différences sont les suivantes :
- Chaque forfait que vous spécifiez concerne un bundle (et non une tranche 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 un nombre illimité de transactions dans le dernier bundle.
Pour obtenir la liste complète des options de détails du forfait, consultez Paramètres de configuration des détails du forfait.
Par exemple, le code suivant crée un forfait avec un modèle de facturation groupé. Le tarif est fixé à 50 $ pour le premier forfait (jusqu'à 1 000 transactions) et à 40 $ pour le deuxième forfait (plus de 1 000 transactions et jusqu'à 2 000 transactions). La base d'agrégation est d'un 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). Un forfait freemium permet aux développeurs d'utiliser sans frais un produit d'API pendant 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 de la grille tarifaire 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 le temps écoulé 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 freemium est basée sur une quantité, indiquez-la sous forme de 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 é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