Passer au contenu principal
GET
Obtenir le statut de facturation
Renvoie l’état de facturation actuel de votre locataire. Utilisez ce point de terminaison dans votre intégration pour détecter les problèmes de paiement tôt et afficher des invites à vos utilisateurs avant que l’accès ne soit restreint. Lorsque tous les paiements sont à jour, feature_mode est NORMAL et grace_until est null. Si un paiement échoue, le compte entre dans un flux de travail d’accès gradué — Dégradé, Restreint, puis Suspendu — avec une période de grâce à chaque étape.

Réponse

string
L’état du compte de facturation : ACTIVE, PAST_DUE, UNPAID, ou SUSPENDED.
string
Le niveau de capacité de la fonctionnalité actuelle :
  • NORMAL — toutes les fonctionnalités disponibles
  • DEGRADED — paiement échoué ; toutes les fonctionnalités fonctionnent toujours pendant la période de grâce
  • RESTRICTED — période de grâce sur le point d’expirer ; les opérations d’écriture (création, création de clés) sont désactivées
  • SUSPENDED — période de grâce expirée ; tout accès API est désactivé jusqu’à ce que le paiement soit résolu
string | null
Horodatage ISO 8601 indiquant la fin de la période de grâce actuelle, ou null si le compte est en règle.
string | null
Un message lisible par l’homme décrivant l’action requise, ou null lorsqu’aucune action n’est nécessaire.

Quand utiliser ce point de terminaison

Utilisez GET /v1/billing/status pour :
  • Afficher les invites de paiement — vérifiez feature_mode au démarrage de l’application ou à la connexion et affichez une bannière lorsque la valeur est différente de NORMAL.
  • Protéger les opérations d’écriture — avant de frapper ou de créer des clés, vérifiez que feature_mode n’est pas RESTRICTED ou SUSPENDED.
  • Suivre les délais de grâce — lisez grace_until pour montrer à vos utilisateurs exactement combien de temps ils ont pour résoudre un problème de paiement.

Délai de grâce

Les fenêtres de grâce par défaut pour le mode de contrat Standard sont : Les contrats d’entreprise ajoutent 14 jours supplémentaires à chaque fenêtre. Les contrats gouvernementaux utilisent une période de grâce fixe de 90 jours sans suspension automatique. Voir modes de contrat pour plus de détails.
Voir échecs de paiement et périodes de grâce pour une description complète du flux de travail d’accès gradué.

Autorisations

X-API-Key
string
header
requis

Clé API pour l'authentification machine-à-machine

Réponse

Statut de la facturation

plan
string
status
string
trial_ends_at
string | null