Aller au contenu
AyiID

Référence API

Facturation

Endpoints de facturation côté vérificateur. Le registre de consommation fait foi. Les routes d’administration (clôture, règlement, plans) sont réservées au rôle admin.

Consommation courante

Réservé au rôle verifier, cadré par son propre identifiant. Renvoie la consommation de la période en cours pour l’environnement effectif (paramètre de requête, sinon environnement du jeton, sinon SANDBOX).

GET/billing/usagerôle : verifier
ChampTypeDescription
environmentSANDBOX | PRODUCTIONEnvironnement ciblé (query). Défaut : celui du jeton, sinon SANDBOX.
1curl "https://api.ayiid.example/billing/usage?environment=PRODUCTION" \
2 -H "authorization: Bearer $ACCESS_TOKEN"

Factures du vérificateur

GET/billing/invoicesrôle : verifier

Renvoie la liste des factures du vérificateur ({ "items": [...] }).

1curl https://api.ayiid.example/billing/invoices \
2 -H "authorization: Bearer $ACCESS_TOKEN"

Administration

Les routes suivantes exigent le rôle admin. Elles gèrent la clôture des périodes, le règlement des factures et les plans tarifaires.

POST/admin/billing/closerôle : admin

Clôt une période et émet une facture (statut ISSUED).

POST/admin/billing/invoices/:id/settlerôle : admin

Règle une facture via KryptaPay.

GET/admin/billing/plansrôle : admin
GET/admin/billing/plans/:idrôle : admin
POST/admin/billing/plansrôle : admin
PATCH/admin/billing/plans/:idrôle : admin
POST/admin/billing/verifiers/:id/planrôle : admin

Assigne un plan à un vérificateur (null = retour au tier modèle).

GET/admin/billing/verifiers/:idrôle : admin

Facturation courante d’un vérificateur (usage + plan résolu).

Modèle de tarification
Le calcul (enveloppe incluse, paliers gradués façon Stripe, frais de plateforme) est détaillé dans Modèle de facturation.