Ajuster la facturation

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

Introduction

La monétisation vous permet de modifier vos informations de facturation. Par exemple, vous devrez peut-être augmenter ou diminuer la part des revenus ou les frais pour un mois de facturation donné en raison d'incohérences dans vos dossiers.

Explorer la page "Ajustements de facturation"

Accédez à la page "Ajustements de facturation", comme indiqué ci-dessous.

Ajouter un ajustement de facturation

Pour ajouter un ajustement de facturation:

1. Accédez à la page "Ajustements de facturation".
2. Cliquez sur + Ajustement.
3. Saisissez les informations suivantes :

   Champ	Description
   Nom	Nom descriptif qui apparaîtra sur le document de facturation.
   % d'ajustement	Montant de l'ajustement, sous forme de pourcentage positif ou négatif. Un pourcentage positif ajuste la part des revenus ou les frais liés à la transaction en fonction de ce pourcentage. Un ajustement négatif réduit le pourcentage des revenus ou les frais associés à la transaction. Saisissez un nombre décimal positif ou négatif (avec jusqu'à deux décimales).
   Mois de facturation	Mois de facturation pour l'ajustement. Sélectionnez un mois dans la liste déroulante.
   Type de transaction	Type de transaction à laquelle vous souhaitez appliquer l'ajustement. Sélectionnez une valeur dans la liste déroulante: Toutes les transactions Frais (transactions de modèle de facturation) Achat (transactions selon le modèle de partage des revenus) Remboursement (transactions selon le modèle de partage des revenus)
   Produit	Produit d'API auquel vous souhaitez appliquer l'ajustement. Vous ne pouvez pas appliquer un même ajustement à plusieurs produits API. Si vous devez appliquer un ajustement à plusieurs produits d'API, créez un ajustement pour chaque produit. Sélectionnez un produit d'API dans le menu déroulant.
   Développeur	Développeur pour lequel vous souhaitez appliquer l'ajustement. Vous pouvez appliquer l'ajustement à tous les développeurs (par défaut) ou à un développeur spécifique. Dans le menu déroulant, sélectionnez "Tous les développeurs" ou un développeur spécifique.

4. Cliquez sur Créer un ajustement.

Modifier un ajustement de facturation

Pour modifier un ajustement de facturation:

1. Accédez à la page "Ajustements de facturation".
2. Placez le curseur sur l'ajustement de facturation que vous souhaitez modifier, puis cliquez sur dans le menu d'actions.
3. Si nécessaire, mettez à jour l'ajustement de facturation.
4. Cliquez sur Mettre à jour l'ajustement.

Effectuer des ajustements de facturation à l'aide de l'API

Les sections suivantes décrivent comment effectuer des ajustements de facturation à l'aide de l'API.

Ajuster la facturation à l'aide de l'API

Vous pouvez ajuster les informations de facturation en envoyant une demande POST à /organizations/{org_name}/billing-adjustments. Lorsque vous effectuez la requête, vous indiquez les éléments suivants dans le corps de la requête:

• Nom de l'ajustement de facturation.
• Un pourcentage d'ajustement, c'est-à-dire une valeur de pourcentage positive ou négative qui augmente ou réduit la facture, respectivement.
• Mois de facturation.
• Année de facturation.
• Organisation à laquelle l'ajustement de facturation est appliqué.

Vous pouvez également spécifier d'autres propriétés, telles que:

• Type de transaction à laquelle vous souhaitez appliquer l'ajustement (une transaction d'achat, par exemple).
• Développeur pour lequel vous souhaitez appliquer l'ajustement.
• Indique si vous souhaitez appliquer l'ajustement aux développeurs prépayés, aux développeurs post-payés ou aux deux.
• Package d'API auquel vous souhaitez appliquer l'ajustement.
• Produit d'API auquel vous souhaitez appliquer l'ajustement.

Consultez la section Paramètres de configuration de l'ajustement de facturation pour obtenir la liste complète des propriétés d'ajustement de facturation que vous pouvez spécifier dans une demande d'ajustement.

Si aucune propriété facultative n'est spécifiée, l'ajustement du document de facturation sera tout compris pour cette propriété. Par exemple, si aucun type de transaction n'est spécifié, l'ajustement de facturation s'applique à tous les types de transactions.

L'exemple suivant permet d'ajuster la facturation pour le mois de facturation en cours (juin 2013). L'ajustement effectue une réduction d'un facteur de 3 %. Il est appliqué aux transactions d'achat, au produit de paiement et aux développeurs post-payés. Étant donné que les propriétés permettant d'identifier un développeur ou un package d'API spécifique ne sont pas spécifiées, l'ajustement sera appliqué à tous les développeurs (qui sont des développeurs post-payés), ainsi qu'au produit de paiement dans tous les packages d'API.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "name": "Purchase Adjustment Negative3",
  "adjustmentPercentageFactor": -3,
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
  },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \
-u email:password

La réponse doit se présenter comme suit (seule une partie de la réponse est affichée) :

{
  "adjustmentPercentageFactor" : -3,
  "billingMonth" : 6,
  "billingYear" : 2017,
  "developerBillingType" : "POSTPAID",
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
  "isPublished" : false,
  "name" : "Purchase Adjustment Negative3",
  "organization" : {
   ...
  },
  "product" : {
    "customAtt1Name" : "user",
    "description" : "Payment",
    "displayName" : "Payment",
    "id" : "payment",
    "name" : "payment",
    "organization" : {
      ...
    },
    "status" : "CREATED",
    "transactionSuccessCriteria" : "Status=='200 OK'"
  },
  "transactionType" : "PURCHASE"
}

Afficher les ajustements de facturation à l'aide de l'API

Vous pouvez afficher un ajustement de facturation spécifique ou tous les ajustements de facturation d'une organisation. Pour afficher un ajustement de facturation spécifique, envoyez une demande GET à /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, où {billing_adjustment_id} correspond à l'identification de l'ajustement de facturation spécifique (l'ID est renvoyé dans la réponse lorsque vous créez l'ajustement de facturation). Exemple :

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

Pour afficher tous les ajustements de facturation d'une organisation, envoyez une requête GET à /organizations/{org_name}/billing-adjustments. Exemple :

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments" \ 
-u email:password

La réponse doit se présenter comme suit (seule une partie de la réponse est affichée) :

{
  "billingAdjustment" : [ {
    "adjustmentPercentageFactor" : -3,
    "billingMonth" : 6,
    "billingYear" : 2017,
    "developerBillingType" : "POSTPAID",
    "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c",
    "isPublished" : false,
    "name" : "Purchase Adjustment Negative3",
    "organization" : {
      ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Payment",
      "displayName" : "Payment",
      "id" : "payment",
      "name" : "payment",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    },
    "transactionType" : "PURCHASE"
  }, {
    "adjustmentPercentageFactor" : 5.0000,
    "billingMonth" : 5,
    "billingYear" : 2017,
    "id" : "53c363c0-7e1d-4dc1-9392-cf86656225f2",
    "isPublished" : false,
    "monetizationPackage" : {
      "description" : "Communications",
      "displayName" : "Communications",
      "id" : "communications",
      "name" : "Communications",
      "organization" : {
       ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "description" : "Messaging",
        "displayName" : "Messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
          ...
        },
        "status" : "CREATED"
      }, {
        ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "Status=='200 OK'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Test Package Adjustment",
    "organization" : {
     ...
    },
    "product" : {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED",
      "transactionSuccessCriteria" : "Status=='200 OK'"
    }
  } ],
  "totalRecords" : 2
}

Mettre à jour un ajustement de facturation à l'aide de l'API

Pour mettre à jour un ajustement de facturation, envoyez une requête PUT à /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, où {billing_adjustment_id} correspond à l'identification de l'ajustement de facturation spécifique. Lorsque vous effectuez la mise à jour, vous devez spécifier les propriétés mises à jour dans le corps de la requête et l'identification de l'ajustement de facturation à mettre à jour. Vous devez également spécifier les propriétés obligatoires pour l'ajustement de facturation, c'est-à-dire les propriétés pour le nom, le pourcentage d'ajustement, le mois de facturation, l'année de facturation et l'organisation.

Par exemple, l'appel d'API suivant met à jour le facteur de pourcentage d'ajustement et le nom (les propriétés mises à jour sont mises en surbrillance dans l'exemple):

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
  "id" : "511144db-7fb1-4c74-bafb-5bc7a6380c9c ",
  "adjustmentPercentageFactor": -5,
  "name" : "Purchase Adjustment Negative5",
  "billingMonth": 6,
  "billingYear": 2017,
  "isPublished": false,
  "transactionType": "PURCHASE",
  "developerBillingType": "POSTPAID",
  "organization": {
      "id": "{org_name}" 
    },
  "product": { "id": "payment" }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

Supprimer un ajustement de facturation à l'aide de l'API

Pour supprimer un ajustement de facturation, envoyez une requête DELETE à /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, où {billing_adjustment_id} correspond à l'identification de l'ajustement de facturation à supprimer. Exemple :

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/billing-adjustments/511144db-7fb1-4c74-bafb-5bc7a6380c9c" \
-u email:password

Paramètres de configuration des ajustements de facturation pour l'API

Les options de configuration suivantes sont disponibles pour les ajustements de facturation:

Nom	Description	Par défaut	Obligatoire ?
name	Nom descriptif de l'ajustement de facturation.	N/A	Oui
adjustmentPercentageFactor	Montant de l'ajustement, sous la forme d'un pourcentage numérique positif ou négatif. Un pourcentage positif ajuste la part des revenus ou les frais liés à la transaction en fonction de ce pourcentage. Un pourcentage négatif réduit la part des revenus ou les frais liés à la transaction en fonction de ce pourcentage. Les valeurs peuvent varier de -100 à 999,9999.	N/A	Oui
billingMonth	Mois de facturation pour l'ajustement de facturation, indiqué sous forme de nombre entier. Par exemple, 11 pour décembre.	N/A	Oui
billingYear	Année de facturation pour l'ajustement de facturation, spécifiée au format suivant : AAAA. Par exemple, 2017.	N/A	Oui
organization	Organisation à laquelle l'ajustement de facturation s'applique.	N/A	Oui
isPublished	Indicateur spécifiant si l'ajustement doit être publié. La valeur peut être l'une des suivantes: true. L'ajustement de facturation devrait être publié. false. L'ajustement de facturation ne doit pas être publié.	N/A	Non
transactionType	Type de transactions pour lesquelles l'ajustement de facturation s'applique. Il peut s'agir de l'un des types suivants: PURCHASE CHARGE REFUND CREDIT BALANCE SETUPFEES TERMINATIONFEES RECURRINGFEES TRUEUPS : transactions utilisées pour réajuster les évaluations. Elles sont appelées lorsque des modifications sont apportées aux taxes au cours du mois de facturation précédent.	N/A	Non
developerBillingType	Type de facturation du développeur auquel l'ajustement de facturation s'applique. La valeur peut être l'une des suivantes: PREPAID.. Développeurs prépayés. POSTPAID. Développeurs avec post-paiement. BOTH. Développeurs prépayés et post-payés.	N/A	Non
product	Produit d'API auquel s'applique l'ajustement de facturation. Si vous ne spécifiez pas cette propriété, l'ajustement de facturation s'applique à tous les produits d'API.	N/A	Non
monetizationPackage	Package d'API auquel l'ajustement de facturation s'applique. Si vous ne spécifiez pas cette propriété, l'ajustement de facturation s'applique à tous les packages d'API.	N/A	Non
developer	Développeur auquel l'ajustement de facturation s'applique. Si vous ne spécifiez pas cette propriété, l'ajustement de facturation s'applique à tous les développeurs.	N/A	Non

Étapes suivantes

La monétisation vous permet d'accorder des crédits à un développeur. Vous devrez peut-être effectuer cette opération si un développeur n'est pas satisfait d'un service et demande un remboursement partiel ou total de son utilisation pendant une période donnée. Découvrez comment émettre des crédits dans Émettre des crédits.