Lister les prélèvements avec l'API Recharge
Liste 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.
- Identifiant
- recharge_list_charges
L'appel
POST https://connect.reportei.com/api/tools/recharge_list_charges/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"status": "<status>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| status | string | Non | Only charges in these statuses, comma-separated: success, queued, error, refunded, partially_refunded, skipped, pending_manual_payment or pending. |
| customer_id | integer | Non | Only charges of this customer, the id from List customers. |
| address_id | integer | Non | Only charges of this address, from the addresses of Get customer. |
| purchase_item_id | integer | Non | Only charges of this subscription, the id from List subscriptions. |
| external_order_id | string | Non | Only the charge of this order of the store platform, the value of external_order_id.ecommerce shown in Get charge. |
| discount_code | string | Non | Only charges with this discount code. |
| ids | string | Non | Comma-separated ids of charges from List charges. |
| scheduled_at_min | string | Non | Only charges scheduled after this date, as YYYY-MM-DD. |
| scheduled_at_max | string | Non | Only charges scheduled before this date, as YYYY-MM-DD. |
| processed_at_min | string | Non | Only charges processed on or after this date, as YYYY-MM-DD, within the last 90 days. |
| processed_at_max | string | Non | Only charges processed on or before this date, as YYYY-MM-DD. |
| sort_by | string | Non | Order of the results. The default is id-asc.Valeurs : id-asc, id-desc, updated_at-asc, updated_at-desc, scheduled_at-asc, scheduled_at-desc |
| limit | integer | Non | Charges per page, up to 250. The default is 50. |
| cursor | string | Non | The next_cursor or previous_cursor of the previous response. |
Connexions possibles
Votre client connecte son compte Recharge une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/recharge_list_charges. Il devient la définition de tool de votre agent sans conversion.
Autres tools Recharge
- 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.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
