Pour créer un abonnement via l'API, vous aurez besoin d'envoyer une requête POST au point de terminaison /abonnements.
Vous pouvez personnaliser les paramètres suivants lorsque vous créez un abonnement ;
- Montant : le montant doit être envoyé en pences ou centimes et ne doit contenir aucun caractère spécial
- Devise : actuellement, GBP et EUR sont les seules devises prises en charge.
- Nom : nom facultatif de l'abonnement, qui servira également de description pour chaque paiement.
- Interval_unit - unité de temps entre les jours de facturation, qu'elle soit hebdomadaire, mensuelle ou annuelle.
- Interval - le nombre d'unités de temps entre chaque jour de facturation. Il doit être équivalent à au moins un jour de facturation par an, et il sera configuré sur 1 par défaut s'il n'est pas fourni.
- Total : nombre total de paiements à prélever dans le cadre de l'abonnement.
- Day_of_month - le jour du mois (du 1 au 28) auquel vous souhaitez facturer votre client. Vous pouvez aussi utiliser -1 pour indiquer le dernier jour du mois.
- Mois : nom du mois de facturation d'un client.
- Start_date - la date de facturation du premier paiement. Cette date doit être au cours de l'année suivant la création de l'abonnement, et à compter du prochain jour de facturation possible (next_possible_charge_date) figurant sur le mandat. Si ce paramètre n'est pas configuré, le premier paiement sera facturé dès que possible.
- Payment_reference - Ce paramètre est réservé aux comptes GoCardless Pro. Il s'agit d'une référence de paiement facultative qui sera définie pour tous les paiements et qui figurera sur le relevé bancaire de votre client.
Par exemple, pour créer un abonnement prélevé
- 25 £
- le 5e jour de chaque mois
- à partir du 02/01/2018
- pendant 12 mois,
vous devrez envoyer la requête POST suivante au point de terminaison /abonnements, qui associe l'identifiant du mandat dans le cadre duquel souhaitez facturer le client :