Menu

Fonctionnement

Création du "SubscriptionModel"

Le subcription model vous permet de pouvoir créer différents types de souscription en fonction de vos services proposés. Par exemple, si vous avez à votre disposition deux types d’offre d’abonnement, le premier en utilisant les caractéristiques de base de votre service et l’autre en utilisant les fonctionnalités avancées, vous allez devoir créer deux plans soit deux subscriptionModel :

  • Un pour le plan "basic"
  • Un pour le plan "avancé"

Chaque "SubscriptionModel" possède un ID unique. Vous fournirez cette valeur d’ID dans les demandes de l’API lorsque vous abonnerez un client au subscriptionModel.

Vous pouvez utiliser les attributs suivants :

  • intervalUnit : jour / semaine / mois / année
  • intervalCount : nombre de jours ou de semaines ou de mois ou d’années entre 2 paiements (exemple : tous les 10 jours ou tous les 3 mois)
  • iterationCount : nombre de fois que le cycle est répété

La liste complete des paramètres est disponible dans notre ref API ici : https://ref-api.centralpay.net/recurring#157-subscription-model

Exemple :

  • If intervalUnit = Jours
  • ET intervalCount = 3
  • ET iterationCount = 3

Ainsi votre modèle d’abonnement sera configuré pour facturer votre client tous les 3 Jours pendant 4 périodes (pour un total d’un abonnement de 12 Jours).

 

Création du "Customer"

Comme les modes de paiement récurrent, la chaîne de processus est simplifiée en utilisant l’objet customer.

Le customer vous permet de stocker des métadonnées telles que le firstName, le lastName ou l’emailAddress. C’est cette notion qui permettra d’initialiser des règlements sur votre client dans le cadre du plan.

Création de la "Subscription"

Pour finaliser le processus, vous devez maintenant lier votre customer et le plan associé subscriptionModel dans une nouvelle subscription.

La liste complete des paramètres est disponible dans notre ref API ici : https://ref-api.centralpay.net/recurring#136-create-a-subscription

Fonctionnement des cycles et "InvoiceItems"

Pour automatiser chaque règlement en automatique, CentralPay crée un invoice pour chaque cycle de facturation.

Contenu d’un invoice :

  • décrit ce que le client doit
  • affiche quand ils seront ou ont été facturés
  • suit l’état du paiement.

invoice peut être utilisée pour ajouter des invoiceItems supplémentaires à une facture (pour ajouter une charge ou faire une remise par exemple).

De là, toutes les activités sont traitées automatiquement. Vous devez donc créer des webhooks pour être informé par notifications lors de la création d’une subscription.

La liste complete des paramètres est disponible dans notre ref API ici : https://ref-api.centralpay.net/recurring#152-create-invoiceitem