List subscriptions with the Asaas API

Lists the subscriptions, optionally filtered by customer, status, billing type or external reference. The payments a subscription generates come from List payments with the subscription filter. Page with offset and limit while hasMore is true.

Identifier
asaas_list_subscriptions

The request

POST https://connect.reportei.com/api/tools/asaas_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 List customers.
statusstringNoOnly the subscriptions in this status. INACTIVE is suspended, and EXPIRED reached its end date or maximum of payments.Values: ACTIVE, INACTIVE, EXPIRED
billingTypestringNoOnly the subscriptions of this billing type.Values: UNDEFINED, BOLETO, CREDIT_CARD, PIX
externalReferencestringNoOnly the subscriptions with this identifier of your own system, saved in externalReference.
includeDeletedstringNotrue also returns the removed subscriptions.Values: true, false
offsetintegerNoPosition of the first subscription of the page. The default is 0; add limit to it for the next page.
limitintegerNoSubscriptions per page, from 1 to 100. The default is 10.

Supported connections

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

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