menu
close

#Abonnés

Cette partie de l'API vous permet de récupérer et de mettre à jour toutes les informations de vos clients.

#Récupérer un client

  • Route: /customers/:customerId
  • Méthode: GET
Permet de récupérer toutes les informations d'un client.
⚠️ Certaines informations peuvent ne pas être présentes dans la réponse suivant le type d'abonnement attaché.
Paramètres
customerId
Type : String
Requis
ID de l'abonné

#Éditer un client

  • Route: /customers/:customerId
  • Méthode: POST
Permet de mettre a jour les informations d'un client.
⚠️ Certaines informations peuvent ne pas être présentes dans la réponse suivant le type d'abonnement attaché.
Paramètres
customerId
Type : String
Requis
ID de l'abonné
Paramètres body
firstName
Type : String
Prénom
lastName
Type : String
Nom
email
Type : String
Adresse email
password
Type : String
Mot de passe
passwordRepeat
Type : String
Requis
Répétition du mot de passe (si password est passé dans la requête, ce paramètre est obligatoire)

#Lier un abonnement externe existant à un client

  • Route: /subscribe/customers/:customerId/subscriptions/:gateway/add/external
  • Méthode: POST
Associe un abonnement déjà créé sur votre plateforme de paiement (stripe, paypal, etc.) à un client.
Paramètres
customerId
Type : String
Requis
ID de l'abonné
gateway
Type : String
Requis
Passerelle de paiement utilisée (stripe, paypal, etc.)
Paramètres body pour Stripe
subscriptionId
Type : String
Requis
Identifiant d'abonnement Stripe
priceId
Type : String
Requis
Identifiant de prix Stripe

#Basculer un abonnement vers une nouvelle offre

  • Route: /subscribe/customers/:customerId/subscriptions/:subscriptionId/change
  • Méthode: POST
Bascule l'abonnement d'un client vers une nouvelle offre.
Paramètres
customerId
Type : String
Requis
ID de l'abonné
subscriptionId
Type : String
Requis
ID de l'abonnement
Paramètres body
offer
Type : String
Requis
ID ou slug de l'offre
opts.priceId
Type : String
Prix de l'offre (ID)

#Annuler un abonnement

  • Route: /subscribe/customers/:customerId/subscriptions/:subscriptionId/cancel
  • Méthode: POST
Annule l'abonnement d'un client.
Paramètres
customerId
Type : String
Requis
ID de l'abonné
subscriptionId
Type : String
Requis
ID de l'abonnement

#Réactiver un abonnement

  • Route: /subscribe/customers/:customerId/subscriptions/:subscriptionId/reactivate
  • Méthode: POST
Réactive un abonnement précédemment annulé pour un client.
Paramètres
customerId
Type : String
Requis
ID de l'abonné
subscriptionId
Type : String
Requis
ID de l'abonnement
arrow_forward
SuivantAuthentification