List customers with the Recharge API

Lists the customers of the store with email, name, the count of active subscriptions and whether the payment method is valid or in dunning. Filter by email to find one customer. Up to 250 per page: pass the next_cursor of the response as cursor.

Identifier
recharge_list_customers

The request

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>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
emailstringNoOnly the customer with this email address.
external_customer_idstringNoOnly the customer with this id in the store platform, the value of external_customer_id.ecommerce shown in Get customer.
idsstringNoComma-separated ids of customers from List customers.
created_at_minstringNoOnly customers created after this date, as YYYY-MM-DD.
created_at_maxstringNoOnly customers created before this date, as YYYY-MM-DD.
updated_at_minstringNoOnly customers updated after this date, as YYYY-MM-DD.
updated_at_maxstringNoOnly customers updated before this date, as YYYY-MM-DD.
limitintegerNoCustomers per page, up to 250. The default is 50.
cursorstringNoThe next_cursor or previous_cursor of the previous response.

Supported connections

Your customer connects their Recharge account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/recharge_list_customers. It becomes your agent's tool definition with no conversion.

Other Recharge tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.