5 endpoints
Clients
Le référentiel de vos clients finaux — nom, e-mail, téléphone —, réutilisé par les abonnements : c'est à l'e-mail du client que partent les liens de chaque échéance.
Les intitulés et descriptions d'endpoints viennent du contrat OpenAPI, en anglais — ils ne peuvent pas diverger de l'API.
Votre clé de test se crée depuis le portail, dès l’activation de votre compte.
En clair
Votre répertoire de clients, avec les coordonnées où partent les liens de paiement.
Quand l'utiliser
Dès que vous voulez reconnaître un client d'un paiement à l'autre : abonnements, ou simplement un historique par client.
Comment l'intégrer
- 1Créez le client une fois, avec son e-mail, et gardez son identifiant de votre côté.
- 2Rattachez-lui ses abonnements : chaque échéance lui est envoyée à cette adresse.
- 3Mettez à jour ses coordonnées quand elles changent : les prochains liens suivent.
- 4Supprimez le client quand il n'a plus d'abonnement actif : c'est sa donnée, pas la vôtre.
- GET
/v1/clients/{id}Récupérer un client - PUT
/v1/clients/{id}Mettre à jour un client - DELETE
/v1/clients/{id}Supprimer un client - GET
/v1/clientsLister les clients - POST
/v1/clientsCréer un client
Récupérer un client
Récupère un client à partir de son UUID.
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
id | string (uuid) | path | Requis | UUID du client. |
Mettre à jour un client
Met à jour le nom, l'e-mail et/ou le téléphone d'un client.
Schéma · UpdateClientRequest
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
id | string (uuid) | path | Requis | |
name | string | body | Optionnel | Nom complet du client. Facultatif ; appliqué uniquement s'il est présent. |
email | string | body | Optionnel | Adresse e-mail du client. Facultative ; appliquée uniquement si présente. |
phone | string | body | Optionnel | Numéro de téléphone du client. Facultatif ; appliqué uniquement si présent. |
Supprimer un client
Supprime un client. Renvoie 204 No Content. Échoue si le client a encore des abonnements actifs.
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
id | string (uuid) | path | Requis |
Lister les clients
Renvoie les clients enregistrés du compte sous forme de Page paginée.
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
origin | enum | query | Optionnel | Filtrer par origine de création (API ou DASHBOARD).Valeurs APIDASHBOARD |
pageable | Pageable | query | Requis |
Créer un client
Crée une fiche client réutilisable pour ce compte.
Schéma · CreateClientRequest
| Champ | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
name | string | body | Requis | Nom complet du client. |
email | string | body | Optionnel | E-mail du client, facultatif. |
phone | string | body | Optionnel | Téléphone du client, facultatif (format E.164). |
Faites votre premier appel en mode test
Créez votre compte, générez votre clé de test depuis le portail et lancez votre première requête aujourd'hui — ou parlez à un intégrateur.
- Gratuit, sans engagement
- Mode test dès l'inscription
- Aucune validation à attendre