Skip to main content
GET
/
api
/
v1
/
account
/
credits
Informations sur les crédits
curl --request GET \
  --url https://app.voicehire.io/api/v1/account/credits \
  --header 'X-API-Key: <api-key>'
{
  "credits_available": 245.5,
  "credits_used_this_month": 154,
  "subscription_type": "VoiceHire Resonance",
  "reset_date": "2024-02-01"
}

​
Réponse

{
  "credits_available": 245.5,
  "credits_used_this_month": 154,
  "subscription_type": "VoiceHire Resonance",
  "reset_date": "2024-02-01"
}
​
credits_available
number
required
Nombre de crédits disponibles sur le compte
​
credits_used_this_month
integer
required
Nombre de crédits utilisés pendant la période en cours
​
subscription_type
string
required
Type d’abonnement actuelTypes possibles:
  • VoiceHire Echo - Plan Echo
  • VoiceHire Resonance - Plan Resonance
  • VoiceHire Symphony - Plan Symphony
  • Pay as you go - Paiement à l’usage
​
reset_date
string
required
Date de réinitialisation des crédits mensuels (format YYYY-MM-DD)

​
Exemple de requête

curl -X GET https://app.voicehire.io/api/v1/account/credits \
  -H "X-API-Key: vh_live_XXXXXXXXXXXXX"

​
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

CodeDescription
401Clé API manquante ou invalide

Authorizations

​
X-API-Key
string
header
required

Clé API au format vh_live_XXXXX

Response

200 - application/json

Informations sur les crédits

​
credits_available
number

Crédits disponibles

Example:

100

​
credits_used_this_month
integer

Crédits utilisés ce mois

Example:

45

​
reset_date
string<date>

Date de réinitialisation mensuelle

Example:

"2025-08-01"

​
subscription_type
enum<string>

Type d'abonnement

Available options:
Pay as you go,
VoiceHire Echo,
VoiceHire Resonance,
VoiceHire Symphony
Example:

"VoiceHire Echo"