List subscriptions with the Stripe API

Lists the subscriptions, newest first, optionally of one customer, one price or one status. Without status, canceled subscriptions are left out. Each subscription has its prices in items.data. Page with starting_after while has_more is true.

Identifier
stripe_list_subscriptions

The request

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

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

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
customerstringNoOnly the subscriptions of this customer, the cus_ id from Search customers.
pricestringNoOnly the subscriptions with this price, the price_ id in items.data.price.id of a subscription returned by List subscriptions or Search subscriptions.
statusstringNoOnly the subscriptions in this status. all includes the canceled ones, and ended means canceled or incomplete_expired.Values: active, all, canceled, ended, incomplete, incomplete_expired, past_due, paused, trialing, unpaid
limitintegerNoSubscriptions per page, from 1 to 100. The default is 10.
starting_afterstringNoId of the last subscription of the previous page, to get the next page.

Supported connections

Your customer connects their Stripe 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/stripe_list_subscriptions. It becomes your agent's tool definition with no conversion.

Other Stripe 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.