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

# Obtenir les informations de crédits

> Récupère le solde de crédits et les informations d'abonnement de votre compte

## Réponse

<ResponseExample>
  ```json theme={null}
  {
    "credits_available": 245.5,
    "credits_used_this_month": 154,
    "subscription_type": "VoiceHire Resonance",
    "reset_date": "2024-02-01"
  }
  ```
</ResponseExample>

<ResponseField name="credits_available" type="number" required>
  Nombre de crédits disponibles sur le compte
</ResponseField>

<ResponseField name="credits_used_this_month" type="integer" required>
  Nombre de crédits utilisés pendant la période en cours
</ResponseField>

<ResponseField name="subscription_type" type="string" required>
  Type d'abonnement actuel

  Types possibles:

  * `VoiceHire Echo` - Plan Echo
  * `VoiceHire Resonance` - Plan Resonance
  * `VoiceHire Symphony` - Plan Symphony
  * `Pay as you go` - Paiement à l'usage
</ResponseField>

<ResponseField name="reset_date" type="string" required>
  Date de réinitialisation des crédits mensuels (format YYYY-MM-DD)
</ResponseField>

## Exemple de requête

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET https://app.voicehire.io/api/v1/account/credits \
    -H "X-API-Key: vh_live_XXXXXXXXXXXXX"
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://app.voicehire.io/api/v1/account/credits",
      headers={
          "X-API-Key": "vh_live_XXXXXXXXXXXXX"
      }
  )

  if response.status_code == 200:
      data = response.json()
      print(f"Crédits disponibles: {data['credits_available']}")
      print(f"Abonnement: {data['subscription_type']}")
  ```

  ```javascript Node.js theme={null}
  const axios = require('axios');

  const response = await axios.get(
    'https://app.voicehire.io/api/v1/account/credits',
    {
      headers: {
        'X-API-Key': 'vh_live_XXXXXXXXXXXXX'
      }
    }
  );

  console.log(`Crédits disponibles: ${response.data.credits_available}`);
  console.log(`Abonnement: ${response.data.subscription_type}`);
  ```
</CodeGroup>

## Notes importantes

* Les crédits sont consommés pour chaque candidat ajouté ou SMS envoyé
* Les crédits mensuels sont réinitialisés à la date indiquée
* Les crédits non utilisés ne sont pas reportés au mois suivant
* Pour les plans Pay-as-you-go, la date de réinitialisation n'est pas applicable

## Codes d'erreur

| Code | Description                   |
| ---- | ----------------------------- |
| 401  | Clé API manquante ou invalide |


## OpenAPI

````yaml GET /api/v1/account/credits
openapi: 3.0.3
info:
  title: VoiceHire API
  description: >
    API REST pour automatiser les campagnes de recrutement avec VoiceHire.


    ## Authentification


    L'API utilise une authentification par clé API. Vous devez inclure votre clé
    API dans l'en-tête `X-API-Key` de chaque requête.


    ```

    X-API-Key: vh_live_XXXXXXXXXXXXX

    ```


    ## Format des réponses


    Toutes les réponses sont au format JSON. Les erreurs suivent un format
    standardisé :


    ```json

    {
      "error": {
        "code": "ERROR_CODE",
        "message": "Description de l'erreur",
        "details": {}
      }
    }

    ```


    ## Limites


    - Les numéros de téléphone doivent être des numéros français (06 ou 07)

    - Maximum 100 candidats par requête d'ajout

    - Les campagnes génèrent automatiquement 6 questions d'entretien
  version: 1.0.0
  contact:
    name: Support VoiceHire
    email: support@voicehire.io
    url: https://www.voicehire.io
servers:
  - url: https://app.voicehire.io
    description: Production
  - url: http://localhost:8080
    description: Développement local
security:
  - ApiKeyAuth: []
tags:
  - name: Campagnes
    description: Gestion des campagnes de recrutement
  - name: Candidats
    description: Gestion des candidats
  - name: Compte
    description: Informations du compte
paths:
  /api/v1/account/credits:
    get:
      tags:
        - Compte
      summary: Informations sur les crédits
      description: Récupère les informations sur les crédits disponibles et l'abonnement
      operationId: getCredits
      responses:
        '200':
          description: Informations sur les crédits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditsInfo'
components:
  schemas:
    CreditsInfo:
      type: object
      properties:
        credits_available:
          type: number
          description: Crédits disponibles
          example: 100
        credits_used_this_month:
          type: integer
          description: Crédits utilisés ce mois
          example: 45
        reset_date:
          type: string
          format: date
          description: Date de réinitialisation mensuelle
          example: '2025-08-01'
        subscription_type:
          type: string
          description: Type d'abonnement
          example: VoiceHire Echo
          enum:
            - Pay as you go
            - VoiceHire Echo
            - VoiceHire Resonance
            - VoiceHire Symphony
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Clé API au format vh_live_XXXXX

````