Tools Recharge
Les 12 opérations Recharge que votre produit exécute sur le compte de votre client via Connect. Elles utilisent toutes le même endpoint, POST /api/tools/{tool}/execute.
- Lister les abonnementsGETListe les abonnements de la boutique avec client, adresse, produit, quantité, prix, fréquence, statut et next_charge_scheduled_at. Jusqu'à 250 par page : passez le next_cursor de la réponse en cursor pour lire la page suivante.
- Consulter un abonnementGETRenvoie un abonnement avec produit, quantité, prix, fréquence, statut, motif d'annulation et next_charge_scheduled_at.
- Créer un abonnementPOSTCrée un abonnement sur une adresse d'un client et le renvoie. Le produit doit avoir au moins un plan dans Recharge. Les champs de fréquence, la date du premier prélèvement, la variante, la quantité et l'adresse sont obligatoires.
- Mettre à jour un abonnementPUTModifie un abonnement actif et le renvoie. Changer order_interval_unit, order_interval_frequency ou charge_interval_frequency exige les trois, recalcule la date du prochain prélèvement et supprime les prélèvements sautés et modifiés manuellement. Pour ne déplacer que le prochain prélèvement, utilisez Set subscription next charge date.
- Annuler un abonnementPOSTAnnule un abonnement actif et le renvoie. Recharge peut envoyer un e-mail au client et au propriétaire de la boutique à ce sujet, sauf si send_email vaut false.
- Réactiver un abonnementPOSTRéactive un abonnement annulé et le renvoie, en effaçant la date et le motif d'annulation.
- Définir la date du prochain prélèvementPOSTDéplace le prochain prélèvement d'un abonnement à une autre date et renvoie l'abonnement. Quand deux abonnements actifs de la même adresse se retrouvent à la même date, leurs prélèvements sont fusionnés en un nouveau prélèvement avec un nouvel id.
- Lister les clientsGETListe les clients de la boutique avec e-mail, nom, le nombre d'abonnements actifs et si le moyen de paiement est valide ou en relance (dunning). Filtrez par e-mail pour retrouver un client. Jusqu'à 250 par page : passez le next_cursor de la réponse en cursor.
- Consulter un clientGETRenvoie un client. Avec include, la réponse contient aussi les adresses, abonnements ou moyens de paiement du client ; l'id de chaque adresse est l'address_id que prend Create subscription.
- Lister les prélèvementsGETListe les prélèvements de la boutique, passés et à venir, avec statut, scheduled_at, processed_at, totaux, client et lignes. Les prélèvements traités depuis plus de 90 jours ne sont pas renvoyés. Triés par id croissant par défaut ; jusqu'à 250 par page : passez le next_cursor de la réponse en cursor pour lire la page suivante.
- Consulter un prélèvementGETRenvoie un prélèvement avec statut, dates, totaux, remises, livraison et les lignes, dont le purchase_item_id est l'abonnement. Un prélèvement traité depuis plus de 90 jours renvoie une erreur.
- Sauter un prélèvementPOSTSaute un prélèvement en file pour les abonnements indiqués et renvoie le prélèvement.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
