List charges with the Recharge API

Lists the charges of the store, past and upcoming, with status, scheduled_at, processed_at, totals, customer and line items. Processed charges older than 90 days are not returned. Sorted by id ascending by default; up to 250 per page: pass the next_cursor of the response as cursor.

Identifier
recharge_list_charges

The request

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

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
statusstringNoOnly charges in these statuses, comma-separated: success, queued, error, refunded, partially_refunded, skipped, pending_manual_payment or pending.
customer_idintegerNoOnly charges of this customer, the id from List customers.
address_idintegerNoOnly charges of this address, from the addresses of Get customer.
purchase_item_idintegerNoOnly charges of this subscription, the id from List subscriptions.
external_order_idstringNoOnly the charge of this order of the store platform, the value of external_order_id.ecommerce shown in Get charge.
discount_codestringNoOnly charges with this discount code.
idsstringNoComma-separated ids of charges from List charges.
scheduled_at_minstringNoOnly charges scheduled after this date, as YYYY-MM-DD.
scheduled_at_maxstringNoOnly charges scheduled before this date, as YYYY-MM-DD.
processed_at_minstringNoOnly charges processed on or after this date, as YYYY-MM-DD, within the last 90 days.
processed_at_maxstringNoOnly charges processed on or before this date, as YYYY-MM-DD.
sort_bystringNoOrder of the results. The default is id-asc.Values: id-asc, id-desc, updated_at-asc, updated_at-desc, scheduled_at-asc, scheduled_at-desc
limitintegerNoCharges 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_charges. 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.