List subscriptions with the Recharge API
Lists the subscriptions of the store with customer, address, product, quantity, price, frequency, status and next_charge_scheduled_at. Up to 250 per page: pass the next_cursor of the response as cursor to read the next page.
- Identifier
- recharge_list_subscriptions
The request
POST https://connect.reportei.com/api/tools/recharge_list_subscriptions/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"status": "active"
}
}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
| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | No | Only subscriptions in this status.Values: active, cancelled, expired |
| customer_id | integer | No | Only subscriptions of this customer, the id from List customers. |
| address_id | integer | No | Only subscriptions of this address, from the addresses of Get customer. |
| external_variant_id | string | No | Only subscriptions of this product variant: the variant id of the store platform, the value of external_variant_id.ecommerce in List subscriptions. |
| ids | string | No | Comma-separated ids of subscriptions from List subscriptions. |
| created_at_min | string | No | Only subscriptions created after this date, as YYYY-MM-DD. |
| created_at_max | string | No | Only subscriptions created before this date, as YYYY-MM-DD. |
| updated_at_min | string | No | Only subscriptions updated after this date, as YYYY-MM-DD. With status cancelled, it finds recent cancellations. |
| updated_at_max | string | No | Only subscriptions updated before this date, as YYYY-MM-DD. |
| limit | integer | No | Subscriptions per page, up to 250. The default is 50. |
| cursor | string | No | The 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_subscriptions. It becomes your agent's tool definition with no conversion.
Other Recharge tools
- Get subscriptionGETReturns one subscription with product, quantity, price, frequency, status, cancellation reason and next_charge_scheduled_at.
- Create subscriptionPOSTCreates a subscription on an address of a customer and returns it. The product needs at least one plan in Recharge. The frequency fields, the first charge date, the variant, the quantity and the address are required.
- Update subscriptionPUTChanges an active subscription and returns it. Changing order_interval_unit, order_interval_frequency or charge_interval_frequency needs all three, recalculates the next charge date and removes skipped and manually changed charges. To move only the next charge, use Set subscription next charge date.
- Cancel subscriptionPOSTCancels an active subscription and returns it. Recharge may email the customer and the store owner about it, unless send_email is false.
- Activate subscriptionPOSTReactivates a cancelled subscription and returns it, clearing the cancellation date and reason.
- Set subscription next charge datePOSTMoves the next charge of a subscription to another date and returns the subscription. When two active subscriptions of the same address end up on the same date, their charges are merged into a new charge with a new id.
- List customersGETLists 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.
- Get customerGETReturns one customer. With include, the response also brings the addresses, subscriptions or payment methods of the customer; the id of each address is the address_id that Create subscription takes.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
