Lister les clients avec l'API Recharge

Liste 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.

Identifiant
recharge_list_customers

L'appel

POST https://connect.reportei.com/api/tools/recharge_list_customers/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "email": "<email>"
  }
}

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ètreTypeObligatoireDescription
emailstringNonOnly the customer with this email address.
external_customer_idstringNonOnly the customer with this id in the store platform, the value of external_customer_id.ecommerce shown in Get customer.
idsstringNonComma-separated ids of customers from List customers.
created_at_minstringNonOnly customers created after this date, as YYYY-MM-DD.
created_at_maxstringNonOnly customers created before this date, as YYYY-MM-DD.
updated_at_minstringNonOnly customers updated after this date, as YYYY-MM-DD.
updated_at_maxstringNonOnly customers updated before this date, as YYYY-MM-DD.
limitintegerNonCustomers per page, up to 250. The default is 50.
cursorstringNonThe 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_customers. Il devient la définition de tool de votre agent sans conversion.

Autres tools Recharge

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.