> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Obtenir le statut de facturation

> Renvoie l'état de facturation actuel, le mode de fonctionnalité et la période de grâce pour le locataire authentifié.

```http theme={null}
GET /v1/billing/status
```

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

**status** `string`

L'état du compte de facturation : `ACTIVE`, `PAST_DUE`, `UNPAID`, ou `SUSPENDED`.

**feature\_mode** `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

**grace\_until** `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.

**banner** `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.

```javascript theme={null}
const res = await fetch("https://api.truthlocks.com/v1/billing/status", {
  headers: { "X-API-Key": "tl_live_..." },
});
const { feature_mode, grace_until } = await res.json();

if (feature_mode !== "NORMAL") {
  showPaymentBanner(feature_mode, grace_until);
}
```

## Délai de grâce

Les fenêtres de grâce par défaut pour le mode de contrat Standard sont :

| Transition | Fenêtre de grâce | Notifications |
| :- | :- | :- |
| NORMAL → DÉGRADÉ | 7 jours | Rappels à T+24h, T+48h, T+72h |
| DÉGRADÉ → RESTREINT | 14 jours | Rappels à T+24h, T+48h, T+72h |
| RESTREINT → SUSPENDU | Immédiat | Avis de suspension final |

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](https://docs.truthlocks.com/fr/billing/overview.md#contract-modes) pour plus de détails.

> [!TIP]
>
> Voir [échecs de paiement et périodes de grâce](https://docs.truthlocks.com/fr/billing/overview.md#payment-failures-and-grace-periods) pour une description complète du flux de travail d'accès gradué.


## OpenAPI

````yaml fr/mint-openapi.yaml GET /v1/billing/status
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks est une infrastructure de vérification universelle pour les
    documents, les identifiants et les actifs numériques.

    Cette spécification définit l'API canonique pour interagir avec les services
    Truthlocks.


    ## URL de base

    - **Production** : `https://api.truthlocks.com`

    - **Sandbox** : `https://sandbox-api.truthlocks.com`


    ## Authentification

    - **Clés API** : Utilisez l'en-tête `X-API-Key` pour les opérations de
    machine à machine

    - **Jetons Bearer** : Utilisez `Authorization: Bearer <jwt>` pour les
    opérations initiées par l'utilisateur


    ## Identité du locataire

    En production, l'identité du locataire est dérivée du contexte authentifié
    (clé API ou JWT).

    L'en-tête `X-Tenant-ID` est ignoré en production pour éviter l'usurpation
    d'identité.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: API de production
  - url: https://sandbox-api.truthlocks.com
    description: Environnement de bac à sable
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gestion des clés API et des jetons
  - name: Issuers
    description: Enregistrement de l'émetteur et gestion de la confiance
  - name: Keys
    description: Gestion des clés cryptographiques pour les émetteurs
  - name: Attestations
    description: Cycle de vie de l'attestation (créer, révoquer, remplacer)
  - name: Verification
    description: Vérification des attestations et lots de preuves
  - name: Governance
    description: Flux de travail de gouvernance de l'émetteur (administrateur uniquement)
  - name: Identity
    description: Gestion de l'organisation, des utilisateurs et des rôles
  - name: Audit
    description: Requêtes d'événements d'audit
  - name: Tenant Console
    description: Points de terminaison du profil et du cycle de vie du locataire
  - name: Health
    description: Points de terminaison de l'état et de la disponibilité du service
  - name: Risk
    description: Ingestion de signaux de risque et détection de fraude
  - name: Risk Enforcement
    description: >-
      Actions d'application des risques — blocage, défi, quarantaine et
      configuration
  - name: Billing
    description: Gestion de la facturation, des abonnements et des modules complémentaires
  - name: Machine Identity
    description: >-
      Protocole d'identité d'agent machine (MAIP) — enregistrement d'agent,
      sessions, confiance, témoin, conformité, orchestration et observabilité
externalDocs:
  description: API de transparence en lecture seule (spécification de service séparée)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/billing/status:
    get:
      tags:
        - Billing
      summary: Obtenir le statut de facturation
      description: >-
        Renvoie le statut de facturation, le plan actuel et les indicateurs de
        fonctionnalité pour le locataire authentifié.
      operationId: billing.status
      responses:
        '200':
          description: Statut de la facturation
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    type: string
                  status:
                    type: string
                  trial_ends_at:
                    nullable: true
                    type: string
        '401':
          description: Authentification requise
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: Code d'erreur lisible par machine
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: Message d'erreur lisible par l'homme
        http_status:
          type: integer
          description: Code de statut HTTP
        retry_after_ms:
          type: integer
          description: >-
            Millisecondes à attendre avant de réessayer (pour les limites de
            débit)
        details:
          type: object
          description: Contexte d'erreur supplémentaire
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Clé API pour l'authentification machine-à-machine
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT pour les opérations initiées par l'utilisateur

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.