Ajuster la facturation

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

Introduction

La monétisation vous permet d'ajuster les informations de facturation. Par exemple, vous devrez peut-être augmenter ou diminuer le partage des revenus ou les frais pour un mois de facturation donné en raison d'une différence dans vos enregistrements.

Explorer la page "Ajustements de facturation"

Accédez à la page "Ajustements de facturation", comme décrit 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.
   Ajustement %	Montant de l'ajustement, exprimé en pourcentage positif ou négatif. Un pourcentage positif ajuste à la hausse le partage des revenus ou les frais de la transaction de ce pourcentage. Un ajustement négatif ajuste à la baisse le partage des revenus ou les frais de la transaction de ce pourcentage. Saisissez un nombre décimal positif ou négatif (avec jusqu'à deux décimales).
   Mois de facturation	Mois de facturation de l'ajustement. Sélectionnez un mois dans la liste déroulante.
   Type de transaction	Type de transaction pour lequel vous souhaitez appliquer l'ajustement. Sélectionnez une valeur dans le menu déroulant : Toutes les transactions Frais (transactions de modèle de facturation) Achat (transactions de modèle de partage des revenus) Remboursement (transactions de modèle de partage des revenus)
   Produit	Produit d'API pour lequel vous souhaitez appliquer l'ajustement. Vous ne pouvez pas appliquer un seul ajustement à plusieurs produits d'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 le ajustement à tous les développeurs (par défaut) ou à un développeur spécifique. Sélectionnez "Tous les développeurs" ou un développeur spécifique dans le menu déroulant.

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. Mettez à jour l'ajustement de facturation, si nécessaire.
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.

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

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

• Nom de l'ajustement de facturation.
• Pourcentage d'ajustement, c'est-à-dire une valeur de pourcentage positive ou négative qui augmente ou réduit respectivement la facture.
• 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 pour lequel vous souhaitez appliquer l'ajustement (par exemple, une transaction d'achat).
• Développeur pour lequel vous souhaitez appliquer l'ajustement.
• Si vous souhaitez appliquer l'ajustement aux développeurs en prépaiement, aux développeurs post-payés ou aux deux.
• Package d'API pour lequel vous souhaitez appliquer l'ajustement.
• Produit d'API pour lequel vous souhaitez appliquer l'ajustement.

Pour obtenir la liste complète des propriétés d'ajustement de facturation que vous pouvez spécifier dans une demande d'ajustement, consultez Paramètres de configuration des ajustements de facturation.

Si une propriété facultative n'est pas 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'appliquera à tous les types de transactions.

L'exemple suivant effectue un ajustement de facturation pour le mois de facturation ouvert, juin 2013. L' ajustement réduit le montant de 3 % et s'applique 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) et 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 requête GET à /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, où {billing_adjustment_id} est 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

Vous pouvez mettre à jour un ajustement de facturation en envoyant une requête PUT à /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, où {billing_adjustment_id} est l'identification de l'ajustement de facturation spécifique. Lorsque vous effectuez la mise à jour, vous devez spécifier dans le corps de la requête les propriétés mises à jour et la 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 du nom, du pourcentage d'ajustement, du mois de facturation, de l'année de facturation et de 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

Vous pouvez supprimer un ajustement de facturation en envoyant une requête DELETE à /organizations/{org_name}/billing-adjustments/{billing_adjustment_id}, où {billing_adjustment_id} est 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 :

Étapes suivantes

La monétisation vous permet d'émettre des crédits pour un développeur. Vous devrez peut-être le faire si un développeur n'est pas satisfait d'un service et demande un remboursement partiel ou total de l'utilisation pendant une période donnée. Pour savoir comment émettre des crédits, consultez Émettre des crédits.