Suivre le solde restant des credits et des commits vous aide à comprendre avec précision la santé des comptes, à prévoir les revenus et à suivre les actifs et passifs. Cela permet également de fournir aux clients des informations à jour sur leur solde restant. Il existe de nombreuses façons d’afficher le solde restant aux clients et Metronome offre la flexibilité d’afficher à la fois des vues agrégées et détaillées.
Les valeurs de solde peuvent être des nombres fractionnaires (par exemple, 0.8 cent pour USD). Lors de l’intégration avec l’API des soldes, ne tronquez pas les soldes en entiers — cela pourrait entraîner une perte de données. L’arrondi est acceptable s’il est effectué intentionnellement. Pour USD, les montants sont libellés en cents, donc un solde de 0.8 représente 0,008 $.
Récupérer le solde restant total d’un client
Pour afficher un solde agrégé en temps réel à vos clients, appelez le point de terminaison /getNetBalance. Ce point de terminaison renvoie une somme agrégée unique du solde restant d’un client, avec un filtrage avancé par type de solde, devise, frais en attente et custom fields.
Construire une vue de registre détaillée des soldes individuels
Metronome prend également en charge des vues plus détaillées des soldes individuels en suivant les entrées de registre via le point de terminaison listBalances. Chaque credit ou commit est associé à un registre, qui enregistre les événements qui modifient le solde du commit ou du credit. L’addition de toutes les entrées d’un registre donne le solde restant total associé à ce registre. Par exemple, il existe des entrées de registre associées au début de l’access_schedule, aux déductions de facture (consommation du credit ou du commit correspondant à l’utilisation) et aux expirations.
Chaque entrée de registre est associée à un type, un amount (qui peut être positif ou négatif) et un timestamp effectif. Il y a une entrée de registre de déduction de facture pour chaque facture qui consomme un credit ou un commit. Le timestamp associé aux entrées de registre de déduction de facture est toujours la fin de la période de service associée à la facture d’utilisation. Utilisez le timestamp pour montrer aux clients leur solde restant en incluant ou en excluant les frais en attente.
Exemple de registre
Considérons un exemple où un client se voit attribuer un credit de 100 avecunsegmentd′acceˋsdu1erseptembre2024au1eroctobre2024.Aucoursdumoisdeseptembre,leclientaconsommeˊ63 du credit. Le solde de credit restant a expiré après le 1er octobre.
En conséquence, ce credit a trois entrées de registre :
| Type | Timestamp | Montant |
|---|
credit_segment_start | 01/09/2024 | +100 $ |
credit_automated_invoice_deduction | 01/10/2024 | -63 $ |
credit_segment_expiration | 01/10/2024 | -37 $ |
Entrées manuelles de registre
Vous pouvez vouloir ajuster le registre d’un credit ou d’un commit pour tenir compte d’erreurs, pour migrer des clients existants avec des soldes en cours vers Metronome, ou pour de nombreuses autres raisons. Appliquez des ajustements positifs ou négatifs au registre d’un credit ou d’un commit via l’application Metronome ou l’API en utilisant le point de terminaison /addManualBalanceLedgerEntry.
Types d’entrées de registre des credits
| Type | Description |
|---|
credit_segment_start | Indique qu’un segment de credit a commencé et que le client a maintenant accès au montant d’utilisation pour ce segment. L’access schedule du credit décrit ces segments. |
credit_automated_invoice_deduction | Représente les déductions du segment de credit causées par une facture d’utilisation qui incluait une utilisation applicable à ce credit. |
credit_segment_expiration | Représente le montant de credit non utilisé qui a expiré à la fin d’un segment de credit. |
credit_manual | Représente une entrée de registre manuelle ajoutée à un credit. |
credit_seat_based_adjustment | Représente le credit supplémentaire associé à un incrément de seat lors de l’utilisation de credits récurrents liés à un abonnement |
Types d’entrées de registre des commits
| Type | Description |
|---|
postpaid_initial_balance | Représente le solde de départ d’un commit postpayé. |
postpaid_automated_invoice_deduction | Représente les déductions de l’obligation restante du commit postpayé suite à une facture comportant une utilisation applicable à ce commit. |
postpaid_trueup | Représente une facture de true-up émise pour ce commit afin de couvrir une utilisation non couverte par les factures d’utilisation automatisées. |
postpaid_rollover | Représente l’utilisation non consommée du commit postpayé qui a été reportée vers un nouveau contrat. |
postpaid_manual | Représente une entrée de registre manuelle ajoutée à un commit postpayé. |
postpaid_commit_expiration | Représente le montant de commit non utilisé et expiré à la fin d’un segment de commit. N’inclut pas l’utilisation qui a été reportée vers un nouveau contrat. |
prepaid_segment_start | Indique qu’un segment de commit prépayé a commencé et que le client a maintenant accès au montant d’utilisation pour ce segment. L’access schedule du commit prépayé décrit ces segments. |
prepaid_automated_invoice_deduction | Représente les déductions du segment de commit prépayé causées par une facture d’utilisation qui incluait une utilisation applicable à ce commit. |
prepaid_rollover | Représente l’utilisation non consommée du commit prépayé qui a été reportée vers un nouveau contrat. |
prepaid_segment_expiration | Représente le montant de commit non utilisé et expiré à la fin d’un segment de commit. N’inclut pas l’utilisation qui a été reportée vers un nouveau contrat. |
prepaid_commit_expiration | Représente le montant de commit non utilisé et expiré à la fin d’un segment de commit. N’inclut pas l’utilisation qui a été reportée vers un nouveau contrat. |
prepaid_manual | Représente une entrée de registre manuelle ajoutée à un commit prépayé. |
prepaid_commit_seat_based_adjustment | Représente le commit supplémentaire associé à un incrément de seat lors de l’utilisation de commits récurrents liés à un abonnement |
